Annotation Queues
List annotation queue records
List the records in an annotation queue with their data and annotations.
Each record includes:
- The record's data as flat key-value pairs
- Any annotations that have been added to the record
- The users assigned to annotate the record and their completion status
- The record's granularity, applicable when the source type is spans
Pagination:
- Response includes pagination with has_more and next_cursor.
- Use cursor-based pagination by passing the returned next_cursor value as the cursor query parameter in subsequent requests.
<Note>This endpoint is in beta, read more here.</Note>
get/v2/annotation-queues/{annotation_queue_id}/records
Path parameters
annotation_queue_idstring required
A universally unique identifier (base64-encoded opaque string).
Example:RW50aXR5OjEyMzQ1
The unique annotation queue identifier (base64)
Query parameters
cursorstring
Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.
limitinteger
Maximum items to return
Response
Returns a list of annotation queue record objects
Example response
{
"records": [
{
"annotations": [
{
"annotator": {
"email": "user@example.com"
}
}
],
"trace_annotations": [
{
"annotator": {
"email": "user@example.com"
}
}
],
"assigned_users": [
{
"user": {
"email": "user@example.com"
}
}
]
}
]
}