strategy. Each queue has a queue_number that callers dial or that DIDs route to, a timeout controlling the maximum hold time in seconds, and a status flag controlling whether the queue is active. All endpoints require an active admin session. The list endpoint supports an optional search parameter that matches against name, queue_number, and strategy. List and show responses include the parent tenant and the assigned agents relations.
GET /api/queues
Returns all call queues ordered by creation date descending, withtenant and agents relations included.
Query parameters
Optional. Filters queues whose
name, queue_number, or strategy contains the given string (case-insensitive).Value is
"Queues fetched successfully.".Array of queue objects.
POST /api/queues
Creates a new call queue and returns201 Created with the record.
ID of the tenant to assign this queue to. Must reference an existing tenant.
Human-readable queue name. Maximum 255 characters.
Dialable number or short code for the queue, e.g.
"5001". Maximum 20 characters.Agent selection strategy, e.g.
roundrobin, leastrecent, ringall. Maximum 100 characters.Maximum caller wait time in seconds. Minimum value:
1.Lifecycle status, e.g.
active or inactive. Maximum 50 characters.Value is
"Queue created successfully.".The newly created queue record.
GET /api/queues/
Fetches a single call queue by its ID. Includes the parenttenant and agents relations.
Path parameters
The numeric ID of the queue to retrieve.
Value is
"Queue loaded successfully.".The queue record with
tenant and agents included.PUT /api/queues/
Replaces all fields on an existing call queue.PATCH /api/queues/{queue} is also accepted and uses the same handler.
Path parameters
The numeric ID of the queue to update.
Must reference an existing tenant.
Maximum 255 characters.
Maximum 20 characters.
Maximum 100 characters.
Minimum value:
1.Maximum 50 characters.
Value is
"Queue updated successfully.".The updated queue record.
DELETE /api/queues/
Permanently deletes the specified call queue. Path parametersThe numeric ID of the queue to delete.
Value is
"Queue deleted successfully.".