Job Statuses
Manage the configurable status values a job can move through
Job statuses define the workflow states a job moves through. Every
organisation starts with four built-in statuses — Open, In Progress,
Completed, and Closed (type: default) — and you can add your own
custom statuses.
A job's status field is a free-form string that typically matches one of
these status names. color is a packed ARGB32 integer used by the app.
Naming note
Job statuses are exposed under the /ticket-statuses collection. The
Servicebay mobile and web apps use the term ticket status internally;
both terms refer to the same resource. The endpoint paths below all begin
with /ticket-statuses.
Defaults and in-use statuses are protected
Statuses created via the API are always type: custom. The four built-in
(type: default) statuses cannot be deleted (400). Deleting the
organisation's last remaining status returns 409 LAST_STATUS. A
status still used by a job returns 409 STATUS_IN_USE. The type
field cannot be changed through an update.
Required scopes: ticket-statuses:read / ticket-statuses:write / ticket-statuses:delete.
Endpoints
- GET
/organisations/{orgId}/ticket-statuses— List statuses (ordered byindex) - POST
/organisations/{orgId}/ticket-statuses— Create a custom status - GET
/organisations/{orgId}/ticket-statuses/{statusId}— Get status - PUT
/organisations/{orgId}/ticket-statuses/{statusId}— Update status - DELETE
/organisations/{orgId}/ticket-statuses/{statusId}— Delete status
Machine-readable version: OpenAPI spec.