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:
- Find your subdomain from your Infinity portal URL (as shown above)
- Get your Bearer token using the
ADMIN_API_CONSUMERclient credential (see Authentication below) - 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
- Click on
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 fieldsconcise— 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=noneto retrieve queues not assigned to any folder. - Use
type=noneto 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_secretor Bearer token to client-side applications. - Implement proper error handling — avoid surfacing internal error details to end users.
