v1
latestOpenAPI 3.0.22026-07-2441902.6 MBList 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.
Query parameters
Allows searching Queues by name.<br/><br/> 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.
Desired page. Defaults to 1.
Quantity of queues to be listed on each page. May change the total number of pages for the same collection.
Allows filtering by the Queue Id (only filtering by one id is allowed). <br/> If the <b>id</b> and <b>name</b> parameters are both filled in, the <b>id prevails</b> because it is the first rule. <br/><br/> To fetch a given queue, fill this query parameter with the Queue id.</a>
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.
Allows filtering by Prompt Id(s). Supports one or more values, separated by commas.<br/><br/> To fetch queues where the agent_waiting_music settings match specific Prompt Id(s), provide the Prompt Id(s) in this query parameter.
Response
Queues list successfully