List all categories

get/category

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/category
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.

Response

List of categories

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of the user who created this record

updatedstring date-time

Last update timestamp

updatedUserIdinteger

ID of the user who last updated this record

namestring

Display name of the category

defaultboolean

1 if this is the default category assigned to new users, 0 otherwise

colorstring

Display color for this category in hex format (e.g. #FF5733)

fileIdinteger

ID of the file used as the category avatar image

statusSystemIdinteger

ID of the StatusSystem assigned to this category

usersinteger[]

IDs of users who belong to this category

resourcesinteger[]

IDs of resources assigned to this category

image_urlstring

URL of the category avatar image

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "name": "Sample name",
    "default": true,
    "color": "#1f6feb",
    "fileId": 42,
    "statusSystemId": 42,
    "users": [
      1
    ],
    "resources": [
      1
    ],
    "status_system": {
      "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"
    },
    "image_url": "https://acme.boost.space"
  }
]

Changes

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