Case Queues

Manage case queues and their agent bindings

get

List case queues for your team.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Query parameters
limitinteger · min: 1 · max: 250Optional

Number of queues per page (1-250, default 250)

Default: 250
offsetinteger · max: 9007199254740991Optional

Number of queues to skip

Responses
200

Default Response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get
/v1/queues
post

Create a new case queue.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Body
namestring · min: 1 · max: 100Required

Queue name. Must be unique within the team.

descriptionstring · max: 500 · nullableOptional

Optional human-readable description.

folder_idstring · uuid · nullableOptional

Optional folder to nest the queue under.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
post
/v1/queues
get

Get a case queue by ID.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
queue_idstring · uuidRequired

The queue's unique identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
get
/v1/queues/{queue_id}
delete

Delete a case queue. Interrupts all associated running jobs first and returns the number of deleted cases plus the IDs of runs that were stopped.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
queue_idstring · uuidRequired

The queue's unique identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
successbooleanRequired
deleted_case_countnumberRequired
interrupted_run_idsstring · uuid[]Required
delete
/v1/queues/{queue_id}
patch

Update a case queue.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
queue_idstring · uuidRequired

The queue's unique identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Body
namestring · min: 1 · max: 100Optional

New queue name. Must be unique within the team.

descriptionstring · max: 500 · nullableOptional

New description, or null to clear.

folder_idstring · uuid · nullableOptional

New folder id, or null to move to the root.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
patch
/v1/queues/{queue_id}
get

List agents bound to a queue as producers (agents that push cases into the queue) or consumers (agents triggered by cases in the queue).

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
queue_idstring · uuidRequired

The queue's unique identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Responses
200

Default Response

application/json
queue_namestringRequired
get
/v1/queues/{queue_id}/agents

Last updated