---
updatedAt: 2026-02-10T11:59:45.000Z
---
# List Queues
Lists all of the queues for an account in ascending name order.
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"x-explorer-enabled": false,
"x-samples-languages": [
"curl",
"node",
"java",
"javascript",
"python",
"go"
],
"info": {
"title": "Admin - Match",
"description": "Administration of categories, attributes, and queues used in Matching.\n\nQueue's are used to identify a pool of contact center agents for which Customer engagements can be matched and routed.\n",
"contact": {
"name": "Avaya API Team",
"url": "https://developers.avayacloud.com/onecloud-ccaas",
"email": "apiteam@avaya.com"
},
"license": {
"name": "Avaya Software Development Kit (SDK) Software License Terms",
"url": "http://support.avaya.com/css/P8/documents/101038288"
},
"version": "1.0.1"
},
"servers": [
{
"url": "{protocol}://{server}{basePath}",
"description": "Open API",
"variables": {
"protocol": {
"enum": [
"http",
"https"
],
"default": "https"
},
"server": {
"default": "HOST-REGION.api.avayacloud.com"
},
"basePath": {
"default": "/api/admin/match/v1"
}
}
},
{
"url": "{protocol}://{server}:{port}",
"description": "Internal API",
"variables": {
"protocol": {
"enum": [
"http",
"https"
],
"default": "http"
},
"server": {
"default": "cc-admin-assisted"
},
"port": {
"enum": [
"80",
"443"
],
"default": "80"
}
}
}
],
"tags": [
{
"name": "Queue",
"description": "Queue's are used to identify a pool of contact center agents for which Customer engagements can be matched and routed.\n"
}
],
"paths": {
"/accounts/{accountId}/queues": {
"get": {
"tags": [
"Queue"
],
"summary": "List Queues",
"description": "Lists all of the queues for an account in ascending name order.",
"operationId": "listQueues",
"parameters": [
{
"$ref": "#/components/parameters/accountId"
},
{
"name": "name",
"in": "query",
"description": "The optional name of the match queue to query.",
"required": false,
"schema": {
"type": "string",
"minLength": 3,
"maxLength": 50,
"example": "EMEA Sales"
}
},
{
"name": "defaultAccountQueue",
"in": "query",
"description": "This 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.",
"required": false,
"schema": {
"type": "boolean",
"example": false
}
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of results per page. Default value is 20, max value is 20.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 20,
"example": 10
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueuePage"
},
"examples": {
"List Queues (Page 1)": {
"$ref": "#/components/examples/ListQueuesPage1"
},
"List Queues (Page 2)": {
"$ref": "#/components/examples/ListQueuesPage2"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
}
},
"security": [
{
"BearerAuth": [],
"AppKey": []
}
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "This API uses Bearer Token Authorization Flow",
"bearerFormat": "JWT"
},
"AppKey": {
"type": "apiKey",
"in": "header",
"name": "appkey",
"description": "This API needs an appKey as header."
}
},
"parameters": {
"accountId": {
"name": "accountId",
"description": "The unique 6 character internal id that represents the customer account",
"required": true,
"in": "path",
"schema": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[a-zA-Z]{6}$",
"example": "ABCDEF"
}
},
"pageNumber": {
"name": "pageNumber",
"in": "query",
"description": "The page number of the records to retrieve. Default value is 1.",
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"minimum": 1,
"example": 1
}
}
},
"responses": {
"BadRequest": {
"description": "Bad Request",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
},
"examples": {
"default": {
"$ref": "#/components/examples/ErrorConstraintViolation"
}
}
}
}
},
"Unauthorized": {
"description": "Unauthorized.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
},
"examples": {
"default": {
"$ref": "#/components/examples/ErrorUnauthorized"
}
}
}
}
},
"Forbidden": {
"description": "Forbidden.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
},
"examples": {
"default": {
"$ref": "#/components/examples/ErrorForbidden"
}
}
}
}
},
"NotFound": {
"description": "Not Found.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
},
"examples": {
"default": {
"$ref": "#/components/examples/ErrorNotFound"
}
}
}
}
},
"InternalServerError": {
"description": "Internal Server Error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
},
"examples": {
"default": {
"$ref": "#/components/examples/ErrorInternalServerError"
}
}
}
}
}
},
"schemas": {
"Problem": {
"type": "object",
"description": "Problem Detail as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs RFC 7807\n",
"properties": {
"type": {
"type": "string",
"format": "uri",
"description": "An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).\n",
"default": "about:blank",
"example": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation"
},
"title": {
"type": "string",
"description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).\n",
"example": "Service Unavailable",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"description": "The HTTP status code generated by the origin server for this occurrence of the problem.\n",
"minimum": 100,
"maximum": 600,
"exclusiveMaximum": true,
"example": 503,
"nullable": true
},
"detail": {
"type": "string",
"description": "A human readable explanation specific to this occurrence of the problem.\n",
"example": "Connection to database timed out",
"nullable": true
},
"instance": {
"type": "string",
"format": "uri",
"description": "An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
"nullable": true
},
"violations": {
"type": "array",
"description": "A list of violations that occurred as a result of invalid data provided as part of a request.\n",
"nullable": true,
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.\n",
"example": "accountId"
},
"message": {
"type": "string",
"description": "A human readable explanation specific to this occurrence of the violation.\n",
"example": "must match \"^[a-zA-Z]{6}$\""
},
"code": {
"type": "integer",
"format": "int32",
"description": "The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.\n",
"example": 20006
}
}
},
"example": [
{
"field": "emailAddress",
"message": "must not be null",
"code": 20002
},
{
"field": "accountId",
"message": "must match \"^[a-zA-Z]{6}$\"",
"code": 20006
}
]
}
}
},
"Pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"description": "The current page number."
},
"pageSize": {
"type": "integer",
"description": "The max number of records that can be retrieved on this page."
},
"total": {
"type": "integer",
"description": "The total number of records."
}
}
},
"Links": {
"type": "object",
"properties": {
"prev": {
"type": "string",
"description": "URL of the previous page. Blank if currently on the first page."
},
"next": {
"type": "string",
"description": "URL of the next page. Blank if currently on the last page."
}
}
},
"QueueId": {
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$",
"description": "The unique 36 character internal id that represents the queue."
},
"QueueName": {
"type": "string",
"minLength": 3,
"maxLength": 50,
"description": "The name of the queue. Name must be unique per account."
},
"QueueDescription": {
"type": "string",
"minLength": 3,
"maxLength": 256,
"description": "A brief description of the intent of the queue."
},
"TimetableId": {
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$",
"description": "The unique 36 character id of the timetable applied to this queue."
},
"Queue": {
"type": "object",
"description": "A Queue is used to identify a pool of contact center agents for which Customer engagements can be matched and routed.",
"required": [
"name"
],
"properties": {
"queueId": {
"$ref": "#/components/schemas/QueueId"
},
"name": {
"$ref": "#/components/schemas/QueueName"
},
"description": {
"$ref": "#/components/schemas/QueueDescription"
},
"timetableId": {
"$ref": "#/components/schemas/TimetableId"
},
"defaultAccountQueue": {
"type": "boolean",
"readOnly": true,
"description": "When true this indicates that this queue is the default queue for the account."
},
"afterContactWork": {
"type": "boolean",
"description": "True indicates that an agent will undertake additional work after a contact (Engagement) on this queue ends.",
"default": false
}
}
},
"QueuePage": {
"type": "object",
"description": "A page containing the current list of queues with links to the previous and next pages.",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"queues": {
"type": "array",
"description": "List of queues.",
"items": {
"$ref": "#/components/schemas/Queue"
}
},
"links": {
"$ref": "#/components/schemas/Links"
}
}
}
},
"examples": {
"ListQueuesPage1": {
"description": "Page of queues.",
"value": {
"pagination": {
"pageNumber": 1,
"pageSize": 3,
"total": 5
},
"queues": [
{
"queueId": "f5c6ec92-8c67-437d-9aaf-35d4b81acdec",
"name": "Default",
"description": "Default queue",
"defaultAccountQueue": true,
"afterContactWork": false
},
{
"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,
"afterContactWork": true
},
{
"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,
"afterContactWork": false
}
],
"links": {
"next": "/api/admin/match/v1/accounts/ABCDEF/queues?pageNumber=2&pageSize=3",
"prev": ""
}
}
},
"ListQueuesPage2": {
"description": "Page of queues.",
"value": {
"pagination": {
"pageNumber": 2,
"pageSize": 3,
"total": 5
},
"queues": [
{
"queueId": "9c602646-80d8-11eb-9439-0242ac130002",
"name": "US Repairs",
"description": "Route enagements to repairs in the US Region",
"timetableId": "7893b4a3-c952-43f5-87c7-8cefa1f49685",
"defaultAccountQueue": false,
"afterContactWork": false
},
{
"queueId": "a69ecaa4-80d8-11eb-9439-0242ac130002",
"name": "EU Billing",
"description": "Route enagements to billing in the EU Region",
"timetableId": "28002f8e-c952-428c-b67f-5a6a4dc96260",
"defaultAccountQueue": false,
"afterContactWork": false
}
],
"links": {
"next": "",
"prev": "/api/admin/match/v1/accounts/ABCDEF/queues?pageNumber=1&pageSize=3"
}
}
},
"ErrorConstraintViolation": {
"description": "Constraint Violation",
"value": {
"type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation",
"title": "Constraint Violation",
"status": 400,
"detail": "A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.",
"violations": [
{
"field": "accountId",
"message": "must match \"^[a-zA-Z]{6}$\"",
"code": 20006
}
]
}
},
"ErrorUnauthorized": {
"description": "Unauthorized",
"value": {
"type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis"
}
},
"ErrorForbidden": {
"description": "Forbidden",
"value": {
"type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden",
"title": "Forbidden",
"status": 403,
"detail": "According to the access control policy the current user and/or accountId does not have permission to access this resource."
}
},
"ErrorNotFound": {
"description": "Not Found",
"value": {
"type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found",
"title": "Resource Not Found",
"status": 404,
"detail": "Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found."
}
},
"ErrorInternalServerError": {
"description": "Server Error",
"value": {
"type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error",
"title": "Server Error",
"status": 500,
"detail": "An internal server error was encountered."
}
}
}
},
"x-readme": {
"proxy-enabled": true
}
}
```