Skip to main content
An AvailableOption represents one value from a fixed, organization-independent reference list — such as a project status, appointment result, or permit status — used by the corresponding *_id field elsewhere in the API. Fetch them through List available options.
id
integer

The option's id — use this value in the corresponding *_id field elsewhere in the API (for example, appointment_result_id, the type_id on project notes, permit_status_id, or site_type_id).

Example:

3

name
string

The option's display name.

Example:

"Production"

description
string | null

A longer description of the option. Only present for file-type and project-status. Null if not set.

color
string

The display color associated with the option. Only present for project-status and work-order-status. For project-status this is always a 6-character hex code without a leading # (for example 2AA21D); for work-order-status it can be either a hex code with a leading # or a named color (for example #FF0033 or grey).

position
integer

The option's position in its display order, lower values first. Only present for project-status, appointment-result, and work-order-status.

order
integer

The option's position in its display order, lower values first. Only present for permit-status.

appointment_category_id
integer

The id of the appointment category this appointment type belongs to. Only present for appointment-type.