API Docs
Voxbi Cockpit APIs
All endpoints

List substatuse

Returns a paginated list of sub statuses. Use the standard search, sort, page, and perPage query parameters; use filter[key]=value to narrow the result set. Multi-tenant scoping is enforced.

No authentication required
search query · string
Free-text search across the resource's searchable fields.
page query · integer
Page number to fetch. Defaults to `1`.
per_page query · integer
Number of items per page. Defaults to `25`, maximum `100`.
sort query · string
Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).
filter[key] query · string
The filter key can be any of the following keys: id, pbx_id, mxvp_user_id, name, icon, font_color, background_color, css, comment, action and sync_tempus. The filter value can be any string or number. You can also apply multiple filters using `filter[key1]=value1&filter[key2]=value2`.
accept header · string
example: application/json

Responses

Response schema
dataarray<object>
Each item — Tempus sub-status: a refinement of a parent status (for example "Lunch" under the "Away" status). Sub-statuses let a status be broken down into more specific activity reasons. Visual styling (icon and colours) is held inside the `style` JSON object. The `usage` array is only present when the related parent statuses have been eager-loaded (typically on a single-resource or detail response). When statuses are not loaded it is returned as an empty array. Each `usage` entry describes a parent `TempusStatus` that references this sub-status, together with the pivot flags that govern how the sub-status behaves under that parent.
id*string · uuid
Unique sub-status identifier.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
name*string
Display name of the sub-status shown to agents and in reports.
length: 0–50
example: Lunch
descriptionstring | null
Optional free-form description explaining the purpose of the sub-status.
example: Midday lunch break
styleobject | null
Visual styling for the sub-status. Drives the icon and colours used when the sub-status is rendered as a pill or badge. Null when no styling is set.
icon_classstring | null
Font Awesome icon identifier used for the sub-status. One of the icon set allowed by the platform (for example "utensils", "coffee", "headset", "car", "home").
example: utensils
font_colorstring | null
Hex colour used for the foreground text or icon.
example: #FFFFFF
bg_colorstring | null
Hex colour used as the sub-status pill background.
example: #E5A100
usage*array<object>
Parent statuses that reference this sub-status, exposed only when the `statuses` relationship is eager-loaded; otherwise returned as an empty array. Each entry is a parent `TempusStatus` enriched with the pivot configuration that controls how the sub-status behaves under that parent.
id*string · uuid
Unique identifier of the parent status.
read-only
example: 550e8400-e29b-41d4-a716-446655440010
parent_idstring | null · uuid
Identifier of the status this parent status is itself nested under, when statuses form a hierarchy. Null for a top-level status.
example: 550e8400-e29b-41d4-a716-446655440011
name*string
Display name of the parent status.
example: Away
descriptionstring | null
Optional free-form description of the parent status.
example: Agent is away from the desk
styleobject | null
Visual styling for the parent status (icon and colours), mirroring the structure of the sub-status `style` object. Null when unset.
icon_classstring | null
Font Awesome icon identifier for the parent status.
example: pause
font_colorstring | null
Hex colour used for the foreground text or icon.
example: #FFFFFF
bg_colorstring | null
Hex colour used as the parent status pill background.
example: #6C757D
availabilitystring | null
Availability behaviour the parent status maps to (for example whether an agent in this status is considered available, away, or offline). Null when not configured.
example: away
meta_dataobject | null
Extended settings for the parent status, such as feature flags. Returned as a free-form JSON object.
example: {"flags":["billable"]}
allow_multiselectboolean
Whether multiple sub-statuses may be selected at once under this parent status. Defaults to false when not set on the pivot.
example:
sub_status_selection_mandatoryboolean
Whether selecting a sub-status is mandatory when an agent enters this parent status. Defaults to false when not set on the pivot.
example:
payableboolean
Whether time recorded under this parent status counts as payable working time. Defaults to false when not set on the pivot.
example: 1
mapping_idstring | null
Optional external mapping identifier used to align this status with a code in an integrated payroll or time-tracking system. Null when no mapping is configured.
example: PAYROLL-LUNCH-01
created_atstring | null · date-time
Timestamp when the parent status was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp when the parent status was last updated.
read-only
example: 2024-03-01T08:29:07Z
created_atstring | null · date-time
Timestamp when the sub-status was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp when the sub-status was last updated.
read-only
example: 2024-03-01T08:29:07Z
linksobject
firststring
The first page of the resource
example: http://localhost/api/v1/resources?page=1
laststring
The last page of the resource
example: http://localhost/api/v1/resources?page=1
prevnull | string
The previous page of the resource
nextnull | string
The next page of the resource
metaobject
current_pageinteger
The current page of the resource
≥ 1
example: 1
fromnull | integer
The first item of the resource
≥ 1
example: 1
last_pageinteger
The last page of the resource
≥ 1
example: 1
linksarray<object>
urlstring | null
The url of the resource (null for the boundary prev/next links)
example: http://localhost/api/v1/resources?page=1
labelstring
The label of the resource
example: first
activeboolean
The status of the resource
example: 1
pathstring
The path of the resource
example: http://localhost/api/v1/resources
per_pageinteger
The number of items per page of the resource
≥ 1
example: 15
tonull | integer
The last item of the resource
≥ 1
example: 1
totalinteger
The total number of items of the resource
≥ 0
example: 1
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/sub-statuses
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/sub-statuses'
const response = await fetch('https://cockpit.voxbi.com/api/v1/sub-statuses', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/sub-statuses')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/sub-statuses', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"data": [ … ],
{ … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"pbx_id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Lunch",
"description": "Lunch break",
"style": { … },
"icon_class": "utensils",
"font_color": "#FFFFFF",
"bg_color": "#E5A100"
},
"created_at": "2024-03-01T08:29:07Z",
"updated_at": "2024-03-01T08:29:07Z",
"deleted_at": "2024-03-01T08:29:07Z"
}
],
"links": { … },
"first": "http://localhost/api/v1/resources?page=1",
"last": "http://localhost/api/v1/resources?page=1"
},
"meta": { … }
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [ … ],
{ … }
"url": "http://localhost/api/v1/resources?page=1",
"label": "first",
"active": true
}
],
"path": "http://localhost/api/v1/resources",
"per_page": 15,
"to": 1,
"total": 1
}
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}