Skip to main content
GET
https://dashboard.laburen.com
/
api
/
annotations
/
{id}
curl --location --request GET 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'

{
  "id": "clxxxxxxxxxxxxxxxxx",
  "messageId": "clxxxxxxxxxxxxxxxxx",
  "organizationId": "clxxxxxxxxxxxxxxxxx",
  "comment": "The agent provided incorrect information about pricing",
  "sentiment": "negative",
  "status": "pending",
  "createdById": "clxxxxxxxxxxxxxxxxx",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "createdBy": {
    "email": "user@example.com"
  },
  "message": {
    "id": "clxxxxxxxxxxxxxxxxx",
    "content": "What are your pricing plans?",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "conversation": {
      "id": "clxxxxxxxxxxxxxxxxx",
      "messages": [
        {
          "id": "clxxxxxxxxxxxxxxxxx",
          "content": "Hello, how can I help you?",
          "agent": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "name": "Support Agent",
            "iconUrl": "https://example.com/icon.png"
          }
        },
        {
          "id": "clxxxxxxxxxxxxxxxxx",
          "content": "What are your pricing plans?",
          "contact": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "phoneNumber": "+1234567890",
            "email": "customer@example.com"
          },
          "annotation": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "sentiment": "negative"
          }
        }
      ]
    }
  },
  "tags": [
    {
      "tag": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "bug"
      }
    }
  ]
}
This endpoint retrieves a single annotation by ID with complete details. It includes:
  • Full annotation details (comment, sentiment, status, tags)
  • Complete conversation context with all messages
  • Message metadata (agent, contact, user, attachments)
  • Chronological message ordering for context
Authentication is required. You must provide a valid session with an organization ID.

​
Path

​
id
string
required
The ID of the annotation to retrieve (CUID format).

​
Response

​
id
string
Unique identifier of the annotation (CUID format).
​
messageId
string
ID of the message this annotation refers to.
​
organizationId
string
ID of the organization the annotation belongs to.
​
comment
string
Comment or feedback text for the annotation.
​
sentiment
string
Sentiment of the annotation (e.g., positive, negative, neutral).
​
status
string
Current status of the annotation.
​
createdById
string
ID of the user who created the annotation.
​
createdAt
string
ISO 8601 timestamp of when the annotation was created.
​
updatedAt
string
ISO 8601 timestamp of when the annotation was last updated.
​
createdBy
object
Information about the user who created the annotation.
​
message
object
The message this annotation refers to, including full conversation context.
​
tags
array
Tags associated with the annotation.

​
Error Responses

Status CodeTypeDescription
401UNAUTHORIZEDMissing or invalid authentication session, or annotation does not belong to your organization.
404NOT_FOUNDAnnotation with the specified ID does not exist.
curl --location --request GET 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'

{
  "id": "clxxxxxxxxxxxxxxxxx",
  "messageId": "clxxxxxxxxxxxxxxxxx",
  "organizationId": "clxxxxxxxxxxxxxxxxx",
  "comment": "The agent provided incorrect information about pricing",
  "sentiment": "negative",
  "status": "pending",
  "createdById": "clxxxxxxxxxxxxxxxxx",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "createdBy": {
    "email": "user@example.com"
  },
  "message": {
    "id": "clxxxxxxxxxxxxxxxxx",
    "content": "What are your pricing plans?",
    "conversationId": "clxxxxxxxxxxxxxxxxx",
    "conversation": {
      "id": "clxxxxxxxxxxxxxxxxx",
      "messages": [
        {
          "id": "clxxxxxxxxxxxxxxxxx",
          "content": "Hello, how can I help you?",
          "agent": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "name": "Support Agent",
            "iconUrl": "https://example.com/icon.png"
          }
        },
        {
          "id": "clxxxxxxxxxxxxxxxxx",
          "content": "What are your pricing plans?",
          "contact": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "phoneNumber": "+1234567890",
            "email": "customer@example.com"
          },
          "annotation": {
            "id": "clxxxxxxxxxxxxxxxxx",
            "sentiment": "negative"
          }
        }
      ]
    }
  },
  "tags": [
    {
      "tag": {
        "id": "clxxxxxxxxxxxxxxxxx",
        "name": "bug"
      }
    }
  ]
}