List Work Order Statuses

Returns a list of Work Order Statuses belonging to your account.

Responses

Response Headers

X-PaginationLimit string
The per page limit. Currently set to 100 but subject to change at any time.
X-Pagination-Current-Page string
The current page. Defaults to 1.
X-Pagination-Total-Pages string
The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.
X-Pagination-Total-Count string
The total number of records in the result set (across all pages).

application/json

Schema
Example (from schema)

Schema

array

id integer

Possible values: >= 1

created_at date-time

The date and time at which this record was created.

updated_at date-time

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

account_id integer

Possible values: >= 1

name string

The name of the Work Order Status.

description string

The description of the Work Order Status.

color string

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

default boolean

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

completed boolean

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

position integer

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

work_orders_count integer

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

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "account_id": 0,
    "name": "string",
    "description": "string",
    "color": "string",
    "default": true,
    "completed": true,
    "position": 0,
    "work_orders_count": 0
  }
]

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}