Work Order Statuses

Retrieve Work Order Status

Retrieve the details of an existing Work Order Status.

get/work_order_statuses/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
namestring required

The name of the Work Order Status.

descriptionstring nullable required

The description of the Work Order Status.

colorstring nullable required

The color of the Work Order Status seen in the UI.

defaultboolean required

Whether or not this is the default Work Order Status applied to new Work Orders.

completedboolean required

Whether Work Orders will be set to completed when they are moved to this status.

positioninteger required

The position of this Work Order Status in the list of statuses.

work_orders_countinteger required

The number of Work Orders that are currently in this status.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.