Statuses

List statuses

get/status/

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/status/
  • Auth: HTTP bearer

Query parameters

filterstring

Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

modulstring

Status module

spaceIdinteger

Status spaceId. Multiple ids can be separated using comma

statusSystemIdinteger

StatusSystem ID

Response

Status list of records

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

created_user_idinteger

ID of the user who created this status

namestring required

Status name

colorstring

Status color

iconstring required

Status icon

icon_prefixstring required

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

weightinteger

Display order position; lower values appear first

status_system_idinteger

ID of the StatusSystem this status belongs to

boostIdstring

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

spacesinteger[]

IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "created_user_id": 42,
    "name": "Sample name",
    "color": "#1f6feb",
    "icon": "string",
    "icon_prefix": "string",
    "weight": 1,
    "status_system_id": 42,
    "boostId": "string",
    "spaces": [
      1
    ],
    "statusSystem": {
      "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.