Sign in
Categories

List all Categories

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_job_categories.

get/category.json

Response

An array of Categories

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-547e-44c9-8b76-23f94eae51bb",
    "edit_date": "2026-03-01 12:00:00"
  }
]

Changes

Changed in 1 of the 50 revisions of this API.4

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added