List Queues

GET https://{{axpAPIDomain}}/api/admin/match/v1/accounts/:accountId/queues?pageNumber=1&pageSize=10

Lists all of the queues for an account in ascending name order.

Request Params

KeyDatatypeRequiredDescription
pageNumbernumberThe page number of the records to retrieve. Default value is 1.
pageSizenumberThe maximum number of results per page. Default value is 20, max value is 20.
namestringThe optional name of the match queue to query.
defaultAccountQueuebooleanThis is an optional field and when true it will return the default Account Queue only, when false it will return a list of all non-default queues.

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"pagination":{"pageNumber":1,"pageSize":3,"total":5},"queues":[{"queueId":"f5c6ec92-8c67-437d-9aaf-35d4b81acdec","name":"Default","description":"Default queue","defaultAccountQueue":true},{"queueId":"689e0f6b-1d27-42a9-af19-9d0b244af0b3","name":"EMEA Sales","description":"Route enagements to sales agents in the EMEA Region","timetableId":"28002f8e-c952-428c-b67f-5a6a4dc96260","defaultAccountQueue":false},{"queueId":"d62d5178-9920-415a-a5d9-066716384750","name":"NA Support","description":"Route enagements to support agents in the NA Region","timetableId":"7893b4a3-c952-43f5-87c7-8cefa1f49685","defaultAccountQueue":false}],"links":{"next":"https://example.avayacloud.com/api/admin/match/api/admin/match/v1/accounts/{{accountId}}/queues?pageNumber=2\u0026pageSize=3","prev":""}}