COconfident-ai
Annotation Queues

List Queue Items

Changed on

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.

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

Request

Path parameters

queueIdstring required

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 date-time

This filters for queue items added after the specified start datetime. Defaulted to 30 days ago.

endstring date-time

This filters for queue items added before the specified end datetime. Defaulted to the current time.

sortBy'addedAt'

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

ascending'true' | 'false'

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

completedstring

Filter by completion status (true for completed, false for pending). Omit to return all items.

Headers

CONFIDENT_API_KEYstring required

The API key of your Confident AI project.

Response

Successfully retrieved list of queue items

successboolean required

Indicates if the request was successful.

Changes

  • ecbd18488092Revision changes
    • breaking

      removed the enum value asc from the query request parameter ascending

    • breaking

      removed the enum value desc from the query request parameter ascending

    • info

      added the new enum value false to the query request parameter ascending

    • info

      added the new enum value true to the query request parameter ascending