Get a category by ID

get/category/{id}

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/category/{id}
Auth: HTTP bearer

Path parameters

idinteger required

Category ID

Response

Category object

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.