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

List queues

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

Returns a list of your queues.

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 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)

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of queues.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error