Get all service ticket states in the system.
Get all service ticket states
This endpoint retrieves the list of states available for service tickets.
Integrators call this endpoint before creating or updating a ticket, to know which state names are currently configured, since the list is managed in the Bloxs application and can change over time.
Request Fields
This endpoint takes no request parameters.
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the state. Values are configurable in the Bloxs application and cannot be managed through the API. Maximum length 256 characters. |
systemState | integer | No | System state linked to this state. Valid values are 1 (Active), 2 (OnHold), 3 (SignedOff), or 4 (Done). Only populated for Bloxs' default states; for custom states created by the user, this is null. The system state can trigger certain actions, for example sending a reminder when a state is set to OnHold, which the user has limited control over. |
OK
Active = 1 OnHold = 2 SignedOff = 3 Done = 4