List Queue Items

(v1)

GET

Retrieves the items in an annotation queue with pagination, in ascending order of when they were added. Use the completed query parameter to return only pending (false) or completed (true) items; omit it to return all.

GET/v1/annotation-queues/{queueId}/items

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

200

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "item-uuid-1",
        "traceUuid": "trace-uuid-1",
        "addedAt": "2025-11-12T10:00:00Z",
        "completed": false,
        "assignedToEmail": "user@example.com"
      },
      {
        "id": "item-uuid-2",
        "spanUuid": "span-uuid-1",
        "addedAt": "2025-11-12T10:01:00Z",
        "completed": true,
        "assignedToEmail": null
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

queueIdstringRequired
The ID of the queue.

Query parameters

pageinteger
This specifies the page number of the queue items to return. Defaulted to 1.
pageSizeinteger
This specifies the maximum number of queue items per page. Defaulted to 25.
startstring
This filters for queue items added after the specified start datetime. Defaulted to 30 days ago.
endstring
This filters for queue items added before the specified end datetime. Defaulted to the current time.
sortByenum
This determines the field to sort by. Defaulted to addedAt.
ascendingenum
This determines if the field specified in sortBy should be in ascending order. Defaults to false.
completedenum
Filter by completion status (true for completed, false for pending). Omit to return all items.

Response

Successfully retrieved list of queue items

successboolean
Indicates if the request was successful.
dataobject
Contains the list of queue items.
Show 1 propertyHide 1 property
- itemslist of objects
  List of items in the annotation queue.
  Show 8 propertiesHide 8 properties
  - idstring
    The unique identifier of the queue item.
  - traceUuidstring
    The UUID of the trace associated with this queue item, if applicable.
  - spanUuidstring
    The UUID of the span associated with this queue item, if applicable.
  - threadIdstring
    The ID of the thread associated with this queue item, if applicable.
  - testCaseIdstring
    The ID of the test case associated with this queue item, if applicable.
  - addedAtstring
    The timestamp when this item was added to the queue.
  - completedboolean
    Whether this queue item has been completed.
  - assignedToEmailstring
    The email address of the user assigned to this queue item, if any.

Built byConfident AI