Skip to main content
GET
List human annotation queues

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991
Example:

0

limit
integer

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

orderBy
enum<string>
default:createdAt

Field to order the result set by.

Available options:
createdAt,
id
Example:

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

topicId
string<uuid>

Filter queues by topic ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

assignedToCurrentUser
boolean

When true, only return queues whose topic is assigned to the calling user (powers the 'Your Topics' tab)

Example:

true

excludeAssignedToOthers
boolean

When true, hide queues whose topic is assigned to a user other than the caller. Unassigned queues and queues assigned to the caller are still returned. Powers the default 'All' tab

Example:

true

includeEmpty
boolean

Include queues with zero pending items. Defaults to false, matching the PRD's sidebar behaviour where empty queues are hidden

Example:

false

Response

Successfully retrieved annotation queues

Paginated response containing human annotation queues

data
HumanAnnotationQueue · object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.