Skip to navigation

Labels — list and create

Manage labels that can be applied to work orders and assets.

Endpoints

MethodPathDescription
GET/labelsList all active labels (paginated, filterable by type)
POST/labelsCreate a label
GET/labels/{labelId}Get a label by ID

Query parameters (GET /labels)

ParameterTypeDefaultDescription
typeWORK | ASSET—Filter by label type. Omit to return all types.
pageinteger1Page number (1-based, max 1000)
page_sizeinteger20Results per page (max 100)

Create a label

POST /labels
{
"name": "Urgent",
"color": "#FF5733",
"type": "WORK"
}
  • name — required, non-empty string.
  • type — required; WORK applies the label to work orders, ASSET to assets. Note: the public API uses WORK where the internal system uses TASK.
  • color — optional hex color code; pass null to create a label with no color.

Label object

{
"id": 101,
"name": "Urgent",
"color": "#FF5733",
"type": "WORK",
"createdAt": "2026-04-30T00:00:00.000Z",
"updatedAt": "2026-04-30T00:00:00.000Z"
}