Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Service Orders

Get a service status

Returns a single service status by ID.

Only available with the Service Orders module enabled.

🔒 Requires: services:read scope

get/service_statuses/{id}

Response

Service status found

created_atstring date-time

The date and time the status was created.

display_namestring

Human-readable name of the status.

display_orderinteger nullable

The order in which this status appears in the UI. Null if not set.

idstring

The unique ID of the status.

retailer_idstring

The retailer this status belongs to.

status_keystring

The underlying key mapping this status to a system status (e.g. NEW, IN_PROGRESS).

system_defaultboolean

Whether this is a system-managed default status.

updated_atstring date-time

The date and time the status was last updated.