Sign in
Categories

Retrieve a Category

OAuth Scope

This endpoint requires the following OAuth scope read_job_categories.

get/category/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Category

Response

Category record

namestring required

The name of the job category. Used to classify and organize jobs.

colourstring

The colour associated with this job category. This colour is used to visually identify the category on the dispatch board and in calendar views. The value is a hexadecimal colour code (6 characters 0-9a-f).

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "uuid": "123e4567-d4a4-4c79-a08b-230c48bf385b",
  "edit_date": "2025-07-01 12:00:00"
}

Changes