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
cXMLREST API
cXMLREST API
  • Core
    • Overview
    • Authorization
    • Error codes
    • Paging
    • REST client SDKs
  • Compatibility REST API
      • GETList All Queues
      • POSTCreate a Queue
      • GETRetrieve a Queue
      • POSTUpdate a Queue
      • DELDelete a Queue
LogoLogoSignalWire Docs
Log inSign up
Support
Compatibility REST APIQueues

Retrieve a Queue

|View as Markdown|Open in Claude|
GET
https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/:AccountSid/Queues/:Sid
GET
/api/laml/2010-04-01/Accounts/:AccountSid/Queues/:Sid
$curl https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Queues/Sid \
>     -u "<project_id>:<api_token>"
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472qu",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "friendly_name": "Queue1",
5  "max_size": 100,
6  "current_size": 0,
7  "average_wait_time": 0,
8  "date_created": "Wed, 26 Sep 2018 18:00:00 +0000",
9  "date_updated": "Thu, 27 Sep 2018 19:00:00 +0000",
10  "api_version": "2010-04-01",
11  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json"
12}

Retrieve a single queue by its unique identifier.

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

Update a Queue

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

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this Queue is associated with.
SidstringRequiredformat: "uuid"
The unique identifier for the queue.

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for the queue.
account_sidstringformat: "uuid"
The unique identifier for the account this Queue is associated with.
friendly_namestring
A description that distinguishes a queue.
max_sizeinteger or null
The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
current_sizeinteger>=0
The number of calls currently waiting in the queue.
average_wait_timeinteger>=0
The average wait time, in seconds, of callers in a queue.
date_createdstring
The date and time, in RFC 2822 format, the Queue was created.
date_updatedstring
The date and time, in RFC 2822 format, the Queue was updated.
api_versionstring
The version of the SignalWire API.
uristring
The URI of this resource, relative to the API base URL.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found 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)