List queues

Returns a paginated list of queues. Results can be filtered by name, active status, folder, and type, and sorted by name, creation date, or last updated date.

Finding Your Customer Subdomain

Your subdomain is found in your Avaya Infinity portal URL and is required for all API calls.

Example: If your portal URL is:

https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/

Your subdomain is: avaya1234

To use this API:

  1. Find your subdomain from your Infinity portal URL (as shown above)
  2. Get your Bearer token using the ADMIN_API_CONSUMER client credential (see Authentication below)
  3. In the API explorer on the right:
    • Click on {customerId} in the URL field and replace it with your actual subdomain
    • Paste your Bearer token in the Credentials section
    • Apply query parameters to filter or paginate results as needed

Authentication

This endpoint requires a valid OAuth 2.0 Bearer token. To get started, contact Avaya Support to request a client_id and client_secret provisioned with the ADMIN_API_CONSUMER scope.

Once you have your credentials, generate an access token and include it in the Authorization: Bearer <token> header of each request.

Working with Filters and Pagination

Use the name parameter to search queues — it performs a prefix/contains match, not an exact match. For example, name=support will return queues named "Support Queue", "Customer Support", etc.

Use the view parameter to control response size:

  • detailed (default) — returns all queue fields
  • concise — returns summary fields only (queueId, name, isActive, type, folderId)

Omit pageSize to return all queues without pagination.

Important Notes

  • Soft-deleted queues are excluded from results by default.
  • Use folderId=none to retrieve queues not assigned to any folder.
  • Use type=none to retrieve queues without a type classification.

DOS Protection & Rate Limiting

  • This endpoint implements DOS protection and rate limiting.

Security Implementation Guidelines

  • Never expose your client_secret or Bearer token to client-side applications.
  • Implement proper error handling — avoid surfacing internal error details to end users.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number (starts from 1).

integer
≥ 1

Number of items per page. Omit to return all queues without pagination.

boolean

Filter by active status. true returns only active queues, false returns only inactive queues.

string

Filter queues by name. Performs a prefix/contains match, not an exact match.

string
length between 26 and 26

Filter by folder ID. Use none to retrieve queues not assigned to any folder.

string

Filter by queue type (e.g., regular, personal). Use none to retrieve queues without a type.

string
enum
Defaults to name

Field to sort results by.

Allowed:
string
enum
Defaults to desc

Sort direction.

Allowed:
string
enum
Defaults to detailed

Response detail level. detailed returns all queue fields. concise returns summary fields only (queueId, name, isActive, type, folderId).

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json