v1
latestOpenAPI 3.0.32026-07-14490228.1 KBGet Sequences
This endpoint retrieves all sequences available to the client.
get/sequences
Query parameters
pageinteger
The current page of results to retrieve.
per_pageinteger
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
sortstring
The order for record sorting. Allowed values are asc and desc.
orderstring
The field for sorting records. Allowed values: id, name, scope, type, length, status.
searchstring
A value to search the name field by for the request.
search_statusesstring[]
The statuses to filter by. Allowed values are active and inactive.
search_number_idsinteger[]
The associated outbound numbers to filter by (using Number IDs).
Response
200
Example response
{
"data": [
{
"id": 1,
"name": "Test Sequence",
"status": "active",
"number_id": 1,
"caller_number_id": 1,
"number": {
"id": 1,
"name": "Test Number",
"number": "+15555555555",
"status": "active",
"catchall_sequence_id": 1
}
}
],
"meta": {
"total": 2,
"count": 2,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "DESC"
}
}