Get queues

Use this method to get a list of queues with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters. More info

Please log in to see full path URL. Learn why.
get
/ccaas/1/queues
query Parameters
queueIds
Array of strings

Optional filter. List of queue Ids.

agentId
string

Optional filter. Agent Id.

workingHoursId
string

Optional filter. Working Hours Id.

limit
integer <int64> <= 999
Default: 10

Size of the result page.

page
integer <int64>
Default: 0

Number of the current page.

orderBy
string

This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.

name
string

Optional. Queue name.

Responses

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Example
cURL
Copy
curl -L -g 'https://{baseUrl}/ccaas/1/queues' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type
application/json
Copy
Collapse all
{
  • "queues":
    [
    • {
      • "id": "a126beb1-f43b-422c-b298-295f65d31e82",
      • "name": "Queue 1",
      • "enabledAgentsCount": 3,
      • "enabledRoutesCount": 2,
      • "isAutoAssignmentEnabled": false,
      • "stickyAgentTimeoutDays": 10,
      • "isStickyAutoAssignmentEnabled": true,
      • "workingHoursId": null,
      • "isPrivate": false,
      • "createdAt": "2024-01-01T00:00:00.000+00:00",
      • "updatedAt": "2024-01-01T00:00:00.000+00:00",
      • "deletedAt": null
      },
    • {
      • "id": "75af6f92-75a6-4364-b293-450281bd21be",
      • "name": "Queue 2",
      • "enabledAgentsCount": 1,
      • "enabledRoutesCount": 4,
      • "isAutoAssignmentEnabled": false,
      • "stickyAgentTimeoutDays": null,
      • "isStickyAutoAssignmentEnabled": false,
      • "workingHoursId": null,
      • "isPrivate": false,
      • "createdAt": "2024-01-01T00:00:00.000+00:00",
      • "updatedAt": "2024-01-01T00:00:00.000+00:00",
      • "deletedAt": null
      }
    ],
  • "pagination":
    {
    • "totalItems": 2,
    • "page": 0,
    • "limit": 10,
    • "orderBy": "id:ASC"
    }
}

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.