For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
      • POSTCreate queue
      • DELDelete queue
      • GETGet queue
      • GETList queues
      • PUTUpdate queue
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingQueues

Get queue

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/queues/:id
GET
/api/relay/rest/queues/:id
$curl https://{your_space_name}.signalwire.com/api/relay/rest/queues/id \
>     -u "<project_id>:<api_token>"
1{
2  "id": "aae131db-214c-46f5-88b6-92004f8467cf",
3  "project_id": "c6c4679b-716a-456a-9e41-a03821005005",
4  "friendly_name": "test",
5  "max_size": 5,
6  "current_size": 0,
7  "average_wait_time": 0,
8  "uri": "/api/relay/rest/queues/aae131db-214c-46f5-88b6-92004f8467cf",
9  "date_created": "2024-01-15T09:30:00Z",
10  "date_updated": "2024-01-15T09:30:00Z"
11}

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.

Was this page helpful?
Previous

List queues

Next
Built with

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
The maximum number of callers allowed in the queue.
current_sizeinteger
The current number of callers in the queue.
average_wait_timeinteger
The average wait time in seconds.
uristring
The URL of this queue.
date_createddatetime
Timestamp when the queue was created.
date_updateddatetime
Timestamp when the queue was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

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)