v1API ReferenceSimple Work Orders

Retrieve a work order

Return one work order by its UUID.

Path Parameters

simple_work_order_id*Simple Work Order Id

The simple work order ID.

Formatuuid4

Response Body

application/json

application/json

Try it live
GET
/v1/simple-work-orders/{simple_work_order_id}

This endpoint requires authentication — paste a token in the Authorization section below.

curl -X GET "https://example.com/v1/simple-work-orders/string"
{  "id": "36f7b519-d93e-4ec8-8245-7f4b8c123456",  "company": {    "id": 1,    "name": "Company 1"  },  "name": "WO-2024-001",  "createdAt": "2024-01-01T00:00:00.000Z",  "updatedAt": "2024-01-01T00:00:00.000Z"}

Search work orders POST

Search work orders, or page through them with `{}`. Results are ordered by name. `simpleWorkOrders` accepts `include` / `exclude` by id. `names.search` is a SQL `LIKE` pattern: use `%` as the wildcard, for example `WO-2024%`.

Rename a work order PATCH

Rename a work order. A name already used by another work order of the company, including a deleted one, returns `409`.