List Queues

GEThttps://api.confident-ai.com/v1/annotation-queues

Retrieves all annotation queues in your project with statistics and pagination support. Each queue includes completion metrics, item counts, and assignment breakdowns.

Filter results by queue type (TRACE, SPAN, THREAD, GOLDEN, TEST_RUN) or search by name. Queues are returned in descending order by creation date.

GET/v1/annotation-queues

curl -X GET "https://api.confident-ai.com/v1/annotation-queues" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "annotationQueues": [
      {
        "id": "queue-uuid-1",
        "name": "Trace Review Queue",
        "type": "TRACE",
        "createdAt": "2025-11-12T10:00:00Z",
        "updatedAt": "2025-11-12T11:00:00Z",
        "completedItems": 45,
        "totalItems": 100,
        "completionPercentage": 45
      },
      {
        "id": "queue-uuid-2",
        "name": "Span Quality Check",
        "type": "SPAN",
        "createdAt": "2025-11-11T09:00:00Z",
        "updatedAt": "2025-11-12T10:00:00Z",
        "completedItems": 20,
        "totalItems": 50,
        "completionPercentage": 40
      }
    ],
    "total": 2
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageinteger
This specifies the page number of the annotation queues to return. Defaulted to 1.
pageSizeinteger
This specifies the maximum number of annotation queues per page. Defaulted to 25.
startstring
This filters for annotation queues created after the specified start datetime. Defaulted to 30 days ago.
endstring
This filters for annotation queues created before the specified end datetime. Defaulted to the current time.
sortByenum
This determines the field to sort by. Defaulted to createdAt.
ascendingenum
This determines if the field specified in sortBy should be in ascending order. Defaults to false.
typeenum
Filter by queue type
searchTermstring
Search queues by name

Response

Successfully retrieved list of annotation queues

successboolean
Indicates if the request was successful.
dataobject
Show 4 propertiesHide 4 properties
- annotationQueueslist of objects
  Show 8 propertiesHide 8 properties
  - idstring
    The unique identifier of the annotation queue.
  - namestring
    The name of the annotation queue.
  - typeenum
    The type of items this queue contains.
    Show 5 enum valuesHide 5 enum values
    TRACE
    SPAN
    THREAD
    GOLDEN
    TEST_RUN
  - createdAtstring
    The timestamp when the annotation queue was created.
  - updatedAtstring
    The timestamp when the annotation queue was last updated.
  - completedItemsinteger
    The number of items in the queue that have been completed.
  - totalItemsinteger
    The total number of items in the queue.
  - completionPercentageinteger
    The percentage of items completed in the queue (0-100).
- totalinteger
  The total number of annotation queues matching the filter criteria.
- limitinteger
  The maximum number of annotation queues returned in this response.
- offsetinteger
  The number of annotation queues skipped in this response.

Built byConfident AI