Create a work order

Work module

POST/work-ordersworkOrders.create

A work order issued against a record, open to bids. Creates a work order. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability work.work_order.write.
OAuth scopes: work.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: WorkOrderCreate

workOrders.create: WorkOrderCreate
Field	Type	Required	Description
project_id	string (uuid)	Yes	Identifier of the project.
record_id	string (uuid) \| null	No	Identifier of the record the work order fulfills.
title	string	Yes	Work order title.Constraints: length 1 to 300
urid	UridAtAnyGrain	No	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
due_at	string (date-time) \| null	No	When the work is due.
budget_minor	integer (int64) \| null	No	Budget for the work. Integer minor units of the resource currency; null means unpriced, never zero.
currency	string	Yes	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Fabricate Bar Fascia",
  "due_at": "2026-10-08T14:30:00Z",
  "budget_minor": 850000,
  "currency": "USD"
}

Response 201: WorkOrder

workOrders.create: WorkOrder
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the work order.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Yes	Identifier of the project.
record_id	string (uuid) \| null	Yes	Identifier of the record the work order fulfills.
title	string	Yes	Work order title.Constraints: length 1 to 300
urid	UridAtAnyGrain	Yes	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
work_order_state	string	Yes	Work order state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
due_at	string (date-time) \| null	Yes	When the work is due.
budget_minor	integer (int64) \| null	Yes	Budget for the work. Integer minor units of the resource currency; null means unpriced, never zero.
currency	string	Yes	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
work_order_number	integer	Yes	Sequence number within the project; the display key is {project_key}-WO-{number}.Constraints: range 1 to any
location_text	string \| null	Yes	Where the work happens, in words, when no zone says it.Constraints: length 1 to 300
scope_of_work	string \| null	Yes	The scope bidders price, in sentence case.Constraints: length 1 to 20000
scheduled_starts_at	string (date-time) \| null	Yes	Planned start.
estimated_hours	number \| null	Yes	Estimated labor hours; null when unestimated.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Fabricate Bar Fascia",
  "urid": "4000.01",
  "work_order_state": "Proposed",
  "due_at": "2026-10-08T14:30:00Z",
  "budget_minor": 850000,
  "currency": "USD",
  "work_order_number": 12,
  "location_text": "Main stage, stage left wing.",
  "scope_of_work": "Supply and hang 24 moving lights.",
  "scheduled_starts_at": "2026-10-08T14:30:00Z",
  "estimated_hours": 16
}

Code samples

curl -X POST "$XOS_BASE_URL/work-orders" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Fabricate Bar Fascia","due_at":"2026-10-08T14:30:00Z","budget_minor":850000,"currency":"USD"}'

const { data } = await xos.workOrders.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "title": "Fabricate Bar Fascia",
    "due_at": "2026-10-08T14:30:00Z",
    "budget_minor": 850000,
    "currency": "USD"
  });

response = xos.work_orders.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "title": "Fabricate Bar Fascia", "due_at": "2026-10-08T14:30:00Z", "budget_minor": 850000, "currency": "USD"})

xos work-orders create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Fabricate Bar Fascia","due_at":"2026-10-08T14:30:00Z","budget_minor":850000,"currency":"USD"}'