List Queues

Returns a paginated list of queues configured for the account.
Use this endpoint to browse available queues, search by name, filter by prompt, or sort results.
Queues represent logical groupings used to route interactions to the appropriate agents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

queues:read

Query Params
string
length ≥ 1

Allows searching Queues by name.

To fetch queues whose name partially or totally match a given string (this will be case insensitive), fill in this query parameter with the string to search for.

integer
≥ 1
Defaults to 1

Desired page. Defaults to 1.

integer
1 to 100
Defaults to 20

Quantity of queues to be listed on each page. May change the total number of pages for the same collection.

string
length ≥ 1

Allows filtering by the Queue Id (only filtering by one id is allowed).
If the id and name parameters are both filled in, the id prevails because it is the first rule.

To fetch a given queue, fill this query parameter with the Queue id.

string
length ≥ 1

The order_by parameter allows you to sort the retrieved results. If not specified, the default sorting will be based on the most recent Queue update (updated_at). Sort by multiple fields is currently not supported.

Supported sort fields

  • name - Sort by queue name

Examples

  • order_by=name:desc - Retrieve results sorted by queue name in descending order.
string
length ≥ 1

Allows filtering by Prompt Id(s). Supports one or more values, separated by commas.

To fetch queues where the agent_waiting_music settings match specific Prompt Id(s), provide the Prompt Id(s) in this query parameter.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json