Retrieve a Queue

View as Markdown

Retrieves the details of a queue.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the queue.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the queue.
project_idstringformat: "uuid"
The project ID associated with this queue.
friendly_namestring
The friendly name of the queue.
max_sizeinteger or null
The maximum number of callers allowed in the queue.
current_sizeinteger or null
The current number of callers in the queue.
average_wait_timeinteger or null
The average wait time in seconds.
uristring or null
The URL of this queue.
date_createddatetime or null
Timestamp when the queue was created.
date_updateddatetime or null
Timestamp when the queue was last updated.

Errors