Routing Queues
Retrieve list of routing queues
Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10
pageTokenstring · max: 8000Optional
Pagination token that keeps of track of the current position in the list
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
Responses
200
OK
application/json
Responseall of
get
GET /workspaces/{workspaceId}/inbox/routing-queues HTTP/1.1
Host:
Authorization: Bearer jwt
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": "2025-07-01T17:40:53.455Z",
"updatedAt": "2025-07-01T17:40:53.455Z"
}
],
"nextPageToken": "text",
"total": 1
}
Create a new routing queue
Authorizations
Path parameters
workspaceIdstringRequired
Body
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
POST /workspaces/{workspaceId}/inbox/routing-queues HTTP/1.1
Host:
Authorization: Bearer jwt
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": "2025-07-01T17:40:53.455Z",
"updatedAt": "2025-07-01T17:40:53.455Z"
}
Retrieves Routing queue.
Authorizations
Path parameters
workspaceIdstringRequired
routingQueueIdstringRequired
Responses
200
ok
application/json
404
Workspace or queue not found.
application/json
get
GET /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Host:
Authorization: Bearer jwt
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": "2025-07-01T17:40:53.455Z",
"updatedAt": "2025-07-01T17:40:53.455Z"
}
Modify the details of a specific routing queue.
Authorizations
Path parameters
workspaceIdstringRequired
routingQueueIdstringRequired
Body
namestring · min: 1 · max: 255Optional
descriptionstringOptional
priorityinteger · max: 100Optional
Responses
200
Updated
application/json
404
Workspace or queue found
application/json
422
Invalid queue
application/json
patch
PATCH /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Host:
Authorization: Bearer jwt
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": "2025-07-01T17:40:53.455Z",
"updatedAt": "2025-07-01T17:40:53.455Z"
}
Delete a Routing queue. Items on the queue will be un-queued, then queue will be deleted.
Authorizations
Path parameters
workspaceIdstringRequired
routingQueueIdstringRequired
Responses
204
Deleted
404
Workspace or queue not found
application/json
delete
DELETE /workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Last updated
Was this helpful?