curl --location --request GET 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
},
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.get(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Authorization": f"Bearer {api_key}",
},
)
data = response.json()
print(data)
{
"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"
}
}
]
}
Annotations
Annotation - Get
Get a single annotation with full details including complete conversation context.
GET
/
api
/
annotations
/
{id}
curl --location --request GET 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
},
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.get(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Authorization": f"Bearer {api_key}",
},
)
data = response.json()
print(data)
{
"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
string
required
The ID of the annotation to retrieve (CUID format).
Response
string
Unique identifier of the annotation (CUID format).
string
ID of the message this annotation refers to.
string
ID of the organization the annotation belongs to.
string
Comment or feedback text for the annotation.
string
Sentiment of the annotation (e.g.,
positive, negative, neutral).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.
Hide CreatedBy object
Hide CreatedBy object
string
Email address of the user who created the annotation.
object
The message this annotation refers to, including full conversation context.
Hide Message object
Hide Message object
string
Unique identifier of the message.
string
Content of the message.
string
ID of the conversation this message belongs to.
object
Complete conversation object with all messages.
Show Conversation object
Show Conversation object
string
Unique identifier of the conversation.
array
All messages in the conversation, ordered chronologically by creation time.
Show Message array items
Show Message array items
string
Unique identifier of the message.
string
Content of the message.
object
object
object
array
array
Error Responses
| Status Code | Type | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid authentication session, or annotation does not belong to your organization. |
| 404 | NOT_FOUND | Annotation with the specified ID does not exist. |
curl --location --request GET 'https://dashboard.laburen.com/api/annotations/clxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer <API_KEY>'
const apiUrl = 'https://dashboard.laburen.com/api';
const apiKey = '<API_KEY>';
const response = await fetch(`${apiUrl}/annotations/clxxxxxxxxxxxxxxxxx`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
},
});
const data = await response.json();
console.log(data);
import requests
api_url = "https://dashboard.laburen.com/api"
api_key = "<API_KEY>"
response = requests.get(
f"{api_url}/annotations/clxxxxxxxxxxxxxxxxx",
headers={
"Authorization": f"Bearer {api_key}",
},
)
data = response.json()
print(data)
{
"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"
}
}
]
}
Was this page helpful?
⌘I

