| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Scope
queues:read
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Allows filtering by Queue ID (only one ID at a time). If both id and name are provided, id takes precedence. Minimum 1 character. |
| name | string | Allows searching queues by name. Returns queues whose name partially or fully matches the given string (case insensitive). Minimum 1 character. |
| order_by | string | Sorts the retrieved results. If not specified, defaults to sorting by most recent queue update (updated_at). Sorting by multiple fields is not currently supported. Minimum 1 character. |
| page | integer | The page number to retrieve. Minimum value: 1. Default: 1. |
| per_page | integer | Number of queues to return per page. Affects the total number of pages for the same collection. Minimum: 1, Maximum: 100. Default: 20. |
| prompt_ids | string | Allows filtering by Prompt ID(s). Accepts one or more values separated by commas. Returns queues where the agent_waiting_music settings match the specified Prompt ID(s). Minimum 1 character. Example: prompt_id1,prompt_id2. |
Body Response
200 OK
| Parameter | Type | Description |
|---|---|---|
| total | integer | Total number of queues. Required. |
| count | integer | Number of queues returned in the current page. Required. |
| page | integer | Current page number. Required. |
| per_page | integer | Number of queues per page. Required. |
| _embedded | object | Container for embedded resources. Required. 1 - "queues" (array[object]) - List of queue objects. Required. |
| _links | object | Pagination and navigation links. Required. 1 - "self" (object) - Link to the current page. Required. |
400 (bad request), 401 (unauthorized), 403 (forbidden), 422 (unprocessable entity), 500 (unexpected error has occurred)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | The error code. Required. | yes |
| message | string | A short description of the error. Required. | yes |
| description | string | A detailed description of the error. | no |
| fields | array[object] | A list of fields associated with the error. 1 - "name" (string) - The name of the field. Required. | yes (name and description) |
TroubleshootingIf you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.