latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Job Sub Status

Retrieve a single Job Sub Status

Retrieves a single Job Sub Status by its ID.

get/v2/jobSubStatus/{id}

Path parameters

idstring required
Example:JSS-BA5r7o4bqzR9MONa

The job sub status ID (prefix JSS-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested Job Sub Status.

idstring

The ID of the job sub status (prefix JSS-).

namestring

The name of the job sub status.

parentNamestring

The name of the parent job status.

color'silver' | 'blue' | 'green' | 'orange' | 'red' | 'anthracite' | 'grey' | 'azure' | 'denim' | 'royalBlue' | 'crimson' | 'cerise' | 'apricot' | 'cream' | 'bronze' | 'yellow' | 'emerald' | 'forest' | 'purple' | 'plum' | 'lavender' | 'violet' | 'slate'

The color key of the job sub status.

Example response

{
  "id": "JSS-BA5r7o4bqzR9MONa",
  "name": "Follow Up",
  "parentName": "In progress",
  "color": "lavender"
}