v1API ReferenceSimple Work Orders

Search work orders

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%.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

Try it live
POST
/v1/simple-work-orders/filters

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

curl -X POST "https://example.com/v1/simple-work-orders/filters" \  -H "Content-Type: application/json" \  -d '{}'
{  "totalCount": 100,  "totalPages": 10,  "currentPage": 1,  "simpleWorkOrders": [    {      "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"    }  ]}

Create work orders POST

Create one or many work orders. The body is a JSON **array**, even for a single record. Creation is idempotent by name: names are trimmed and de-duplicated, a work order that already exists is returned as-is, and one that was deleted is restored rather than duplicated.

Retrieve a work order GET

Return one work order by its UUID.