Get a queue

Returns the full configuration details for a specific queue by its ID.

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
    • Enter the id of the queue you want to retrieve

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 Queue IDs

Queue IDs are system-generated identifiers in the format 003xxxxxxxxxxxxxxxxxxxxxxx. They can be found in the response of POST /queues or GET /queues, or in the Avaya Infinity portal URL when viewing a queue's configuration.

Important Notes

  • Returns a 404 if no queue exists with the specified ID.

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…
Path Params
string
required
length between 23 and 26
^003[0-9a-f]{20,23}$

The unique identifier of the queue to retrieve.

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