Statuses

Get a system status by ID

get/status-system/{statusSystemId}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/status-system/{statusSystemId}
  • Auth: HTTP bearer

Path parameters

statusSystemIdinteger required

ID of StatusSystem

Response

StatusSystem record

idinteger

Unique identifier - primary key

colorstring

Status system color

icon_prefixstring

Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

iconstring

Status system icon

modulestring

Module type this status system is associated with (e.g. contact, deal, todo)

weightinteger

Display order position; lower values appear first

namestring

Status system name

system_namestring

Internal system-level identifier for this status system, used to reference built-in status systems by a stable key

activatedinteger

Whether this status system is active and available for use; 1 = active, 0 = inactive

customboolean

Whether this is a user-defined custom status system (1) or a built-in system status system (0)

allow_movestring

Serialized JSON rule set defining which status transitions are permitted within this status system

boostIdstring

Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

Example response

{
  "id": 42,
  "color": "#1f6feb",
  "icon_prefix": "string",
  "icon": "string",
  "module": "string",
  "weight": 1,
  "name": "Sample name",
  "system_name": "Sample system_name",
  "activated": 1,
  "custom": true,
  "allow_move": "string",
  "boostId": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.