Routing Queues

List routing queues

get

Retrieve list of routing queues

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

nextPageTokenstringOptional

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalintegerOptional

The total number of results across all pages.

get

/workspaces/{workspaceId}/inbox/routing-queues

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/inbox/routing-queues HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "priority": 1,
      "teams": [
        {
          "type": "primary",
          "ids": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "queuedItems": {
        "email": [],
        "messaging": [],
        "voice": []
      },
      "createdAt": "2026-03-24T04:26:21.056Z",
      "updatedAt": "2026-03-24T04:26:21.056Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Create a routing queue

post

Create a new routing queue

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Body

application/json

namestring · min: 1 · max: 255Required

descriptionstringOptional

priorityinteger · max: 100Required

Responses

201

created

application/json

404

Workspace not found

application/json

422

Invalid request

application/json

post

/workspaces/{workspaceId}/inbox/routing-queues

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/inbox/routing-queues HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "name": "text",
  "description": "text",
  "priority": 1,
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  },
  "createdAt": "2026-03-24T04:26:21.056Z",
  "updatedAt": "2026-03-24T04:26:21.056Z"
}

Get routing queue

get

Retrieves Routing queue.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

routingQueueIdstringRequired

Responses

200

ok

application/json

idstring · uuidRequired

workspaceIdstring · uuidRequired

namestring · min: 1 · max: 255Required

descriptionstringRequired

priorityinteger · max: 100Required

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

404

Workspace or queue not found.

application/json

get

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  },
  "createdAt": "2026-03-24T04:26:21.056Z",
  "updatedAt": "2026-03-24T04:26:21.056Z"
}

Update a Routing queue

patch

Modify the details of a specific routing queue.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

routingQueueIdstringRequired

Body

application/json

namestring · min: 1 · max: 255Optional

descriptionstringOptional

priorityinteger · max: 100Optional

Responses

200

Updated

application/json

idstring · uuidRequired

workspaceIdstring · uuidRequired

namestring · min: 1 · max: 255Required

descriptionstringRequired

priorityinteger · max: 100Required

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

404

Workspace or queue found

application/json

422

Invalid queue

application/json

patch

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "name": "text",
  "description": "text",
  "priority": 1,
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  },
  "createdAt": "2026-03-24T04:26:21.056Z",
  "updatedAt": "2026-03-24T04:26:21.056Z"
}

Delete a Routing queue

delete

Delete a Routing queue. Items on the queue will be un-queued, then queue will be deleted.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

routingQueueIdstringRequired

Responses

204

Deleted

404

Workspace or queue not found

application/json

delete

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content