Work order notes and work items

New: Work order notes endpoints

You can now create and list notes directly on work orders.

MethodPathDescription
POST/work-orders/{workOrderId}/notesAdd a note to a work order
GET/work-orders/{workOrderId}/notesList all notes on a work order

Create a note

POST /work-orders/{workOrderId}/notes
{
"body": "Panels installed. Awaiting inspection sign-off.",
"fileIds": []
}

Response:

{
"id": 4029970,
"note": "Panels installed. Awaiting inspection sign-off.",
"createdAt": "2026-04-15T22:41:03.548Z",
"updatedAt": "2026-04-15T22:41:03.548Z"
}

List notes

GET /work-orders/{workOrderId}/notes?page=1&page_size=20
{
"notes": [
{
"id": 4029970,
"note": "Panels installed. Awaiting inspection sign-off.",
"createdAt": "2026-04-15T22:41:03.548Z",
"createdByUser": {
"id": 42,
"firstName": "Jane",
"lastName": "Doe",
"email": "jane@example.com"
}
}
],
"totalCount": 1
}

New: workItems on work order responses

GET /work-orders/{workOrderId} now includes a workItems array containing Blueprint workflow items linked to the work order. Two types are supported:

  • FORM — a form instance (e.g. site survey, roof mount checklist)
  • FILE_REQUEST — a document upload request (e.g. shade report)
{
"id": 2025433,
"title": "[BP] Tech site audit (post-sale)",
"workItems": [
{
"type": "FORM",
"id": 1236647,
"name": "[BP] Site Survey - Roof Mount",
"templateId": 50,
"status": "OPEN",
"isCompleted": false,
"completedAt": null,
"dueDate": null
},
{
"type": "FILE_REQUEST",
"id": 2556,
"name": "Shade Report",
"status": "IN_PROGRESS"
}
]
}

If no work items are linked, workItems is an empty array.