Annotation Queues

List Queue Items

Retrieves all items in an annotation queue with pagination and optional filtering by completion status.

Use the completed query parameter to filter for pending items (false) or completed items (true). Omit this parameter to retrieve all items regardless of completion status. Items are returned in ascending order by the time they were added to the queue.

Path parameters

queueIdstringRequired
The ID of the queue.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerOptional>=1
This specifies the page number of the queue items to return. Defaulted to 1.
pageSizeintegerOptional>=1
This specifies the maximum number of queue items per page. Defaulted to 25.
startstringOptionalformat: "date-time"
This filters for queue items added after the specified start datetime. Defaulted to 30 days ago.
endstringOptionalformat: "date-time"
This filters for queue items added before the specified end datetime. Defaulted to the current time.
sortByenumOptional

This determines the field to sort by. Defaulted to addedAt.

Allowed values:
ascendingbooleanOptional

This determines if the field specified in sortBy should be in ascending order. Defaults to false.

completedstringOptional

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.