Annotation - List - Laburen Documentacion

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending' \
--header 'Authorization: Bearer <API_KEY>'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&sentiment=good'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?cursor=clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

// List annotations with filters
const response = await fetch(`${apiUrl}/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

// Pagination example
const nextPage = await fetch(`${apiUrl}/annotations?cursor=${data[data.length - 1].id}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

# List annotations with filters
response = requests.get(
    f"{api_url}/annotations",
    params={
        "agentId": "clxxxxxxxxxxxxxxxxx",
        "status": "pending",
    },
    headers={
        "Authorization": f"Bearer {api_key}",
    },
)

data = response.json()
print(data)

# Pagination example
if data:
    last_id = data[-1]["id"]
    next_page = requests.get(
        f"{api_url}/annotations",
        params={"cursor": last_id},
        headers={
            "Authorization": f"Bearer {api_key}",
        },
    )

[
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "The agent provided incorrect information about pricing",
    "sentiment": "bad",
    "status": "pending",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": [
      {
        "tag": {
          "id": "clxxxxxxxxxxxxxxxxx",
          "name": "bug"
        }
      }
    ]
  },
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "Great response, very helpful!",
    "sentiment": "good",
    "status": "completed",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T09:15:00.000Z",
    "updatedAt": "2024-01-15T09:15:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": []
  }
]

GET

api

annotations

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending' \
--header 'Authorization: Bearer <API_KEY>'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&sentiment=good'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?cursor=clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

// List annotations with filters
const response = await fetch(`${apiUrl}/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

// Pagination example
const nextPage = await fetch(`${apiUrl}/annotations?cursor=${data[data.length - 1].id}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

# List annotations with filters
response = requests.get(
    f"{api_url}/annotations",
    params={
        "agentId": "clxxxxxxxxxxxxxxxxx",
        "status": "pending",
    },
    headers={
        "Authorization": f"Bearer {api_key}",
    },
)

data = response.json()
print(data)

# Pagination example
if data:
    last_id = data[-1]["id"]
    next_page = requests.get(
        f"{api_url}/annotations",
        params={"cursor": last_id},
        headers={
            "Authorization": f"Bearer {api_key}",
        },
    )

[
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "The agent provided incorrect information about pricing",
    "sentiment": "bad",
    "status": "pending",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": [
      {
        "tag": {
          "id": "clxxxxxxxxxxxxxxxxx",
          "name": "bug"
        }
      }
    ]
  },
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "Great response, very helpful!",
    "sentiment": "good",
    "status": "completed",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T09:15:00.000Z",
    "updatedAt": "2024-01-15T09:15:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": []
  }
]

This endpoint retrieves a paginated list of annotations with optional filters. It supports:

Filtering by agent, sentiment, conversation, message, or status
Cursor-based pagination (20 items per page)
Public agent access (no authentication required for public agents)
Optimized response with minimal includes for performance

Authentication is optional. If no session is provided, you must include a messageId or agentId query parameter referencing a public agent to resolve the organization.

Query Parameters

string

Filter annotations by agent ID (CUID format). Also used to resolve organization for public agents when no session is provided.

string

Filter annotations by sentiment. Valid values: good, bad (case-insensitive).

string

Filter annotations by conversation ID (CUID format).

string

Filter annotations by message ID (CUID format). Also used to resolve organization for public agents when no session is provided.

string

Filter annotations by status. Valid values depend on your organization’s configuration.

string

Cursor for pagination. Use the id of the last item from the previous page to fetch the next page.

Response

The response is an array of annotation objects (up to 20 items per page).

string

Unique identifier of the annotation (CUID format).

string

ID of the message this annotation refers to.

string

ID of the conversation this annotation belongs to.

string

ID of the agent associated with this annotation.

string

ID of the organization the annotation belongs to.

string

Comment or feedback text for the annotation.

string

Sentiment of the annotation (e.g., good, bad).

string

Current status of the annotation.

string

ID of the user who created the annotation.

string

ISO 8601 timestamp of when the annotation was created.

string

ISO 8601 timestamp of when the annotation was last updated.

object

Information about the user who created the annotation (minimal includes for performance).

Hide CreatedBy object

string

Email address of the user who created the annotation.

array

Tags associated with the annotation.

Show Tags array items

object

Tag information.

Show Tag object

string

Tag ID.

string

Tag name.

This endpoint returns minimal data for performance. For full annotation details including complete conversation context, use the Get Annotation endpoint.

Error Responses

Status Code	Type	Description
401	UNAUTHORIZED	No valid session and no public agent `agentId` or `messageId` provided, or the agent is not public.

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending' \
--header 'Authorization: Bearer <API_KEY>'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?agentId=clxxxxxxxxxxxxxxxxx&sentiment=good'

curl --location --request GET 'https://dashboard.laburen.com/api/annotations?cursor=clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'

const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';

// List annotations with filters
const response = await fetch(`${apiUrl}/annotations?agentId=clxxxxxxxxxxxxxxxxx&status=pending`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

// Pagination example
const nextPage = await fetch(`${apiUrl}/annotations?cursor=${data[data.length - 1].id}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

import requests

api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"

# List annotations with filters
response = requests.get(
    f"{api_url}/annotations",
    params={
        "agentId": "clxxxxxxxxxxxxxxxxx",
        "status": "pending",
    },
    headers={
        "Authorization": f"Bearer {api_key}",
    },
)

data = response.json()
print(data)

# Pagination example
if data:
    last_id = data[-1]["id"]
    next_page = requests.get(
        f"{api_url}/annotations",
        params={"cursor": last_id},
        headers={
            "Authorization": f"Bearer {api_key}",
        },
    )

[
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "The agent provided incorrect information about pricing",
    "sentiment": "bad",
    "status": "pending",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": [
      {
        "tag": {
          "id": "clxxxxxxxxxxxxxxxxx",
          "name": "bug"
        }
      }
    ]
  },
  {
    "id": "clxxxxxxxxxxxxxxxxx",
    "messageId": "clxxxxxxxxxxxxxxxxx",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "agentId": "clxxxxxxxxxxxxxxxxx",
    "organizationId": "clxxxxxxxxxxxxxxxxx",
    "comment": "Great response, very helpful!",
    "sentiment": "good",
    "status": "completed",
    "createdById": "clxxxxxxxxxxxxxxxxx",
    "createdAt": "2024-01-15T09:15:00.000Z",
    "updatedAt": "2024-01-15T09:15:00.000Z",
    "createdBy": {
      "email": "user@example.com"
    },
    "tags": []
  }
]

laburen API

Endpoints

Annotation - List

Query Parameters

Response

Error Responses

​Query Parameters

​Response

​Error Responses

Query Parameters

Response

Error Responses