Get Work Order | Coperniq API

const url = 'https://api.coperniq.io/v1/work-orders/1';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 2005936,
  "uid": 549,
  "templateId": 889194,
  "createdAt": "2026-02-23T16:16:05.251-08:00",
  "updatedAt": "2026-04-15T10:00:00.000-07:00",
  "title": "[BP] Tech site audit (post-sale)",
  "description": "<p>Complete Checklist Items below and fill out any applicable Forms.</p>",
  "priority": 2,
  "startDate": null,
  "startDateAllDay": false,
  "endDate": "2026-04-16T12:00:00-07:00",
  "endDateAllDay": true,
  "completedAt": null,
  "isArchived": false,
  "isCompleted": false,
  "isField": true,
  "labels": [],
  "project": {
    "id": 789225,
    "uid": 42,
    "title": "Michael Scott",
    "address": [
      "123 North Main Avenue, Scranton, PA 18504"
    ],
    "stage": null
  },
  "assignee": {
    "id": 10299,
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com"
  },
  "collaborators": [],
  "visits": {
    "visits": []
  },
  "statuses": [],
  "status": {
    "id": "ASSIGNED",
    "label": "Assigned"
  },
  "checklist": [
    {
      "id": 8310528,
      "detail": "[Scheduler] Schedule Visit with Client",
      "isCompleted": false,
      "completedAt": null
    }
  ],
  "workItems": [
    {
      "type": "FORM",
      "id": 1236647,
      "completedAt": null,
      "dueDate": null,
      "isCompleted": false,
      "name": "[BP] Site Survey - Roof Mount",
      "status": "OPEN",
      "templateId": 50
    },
    {
      "type": "FILE_REQUEST",
      "id": 2556,
      "name": "Shade Report",
      "status": "IN_PROGRESS"
    }
  ]
}

Retrieve a specific work order by ID.

The lineItems property is returned only for service work orders on an account (parent project type ACCOUNT), and only when at least one line item exists. Otherwise the field is omitted from the JSON object.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

workOrderIdintegerRequired

Work order identifier

Response

Work order details

idinteger

Work order identifier

uidinteger

Unique work order number within the project

templateIdinteger

Template identifier for the work order

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Work order title

descriptionstring

Work order description

priorityinteger

Priority level

startDatestring or nullformat: "date-time"

Scheduled start date

startDateAllDayboolean

Whether the start date is an all-day event

endDatestring or nullformat: "date-time"

Scheduled end date

endDateAllDayboolean

Whether the end date is an all-day event

completedAtstring or nullformat: "date-time"

Timestamp when the work order was completed

isArchivedboolean

Whether the work order is archived

isCompletedboolean

Whether the work order is completed

isFieldboolean

Whether the work order is a field task

labelslist of objects

Labels associated with the work order

projectobject

Project associated with the work order

assigneeobject or null

User assigned to the work order

collaboratorslist of objects

Additional users collaborating on the work order

visitsobject

Site visits associated with the work order (legacy shape)

statuseslist of objects

History of status changes and time spent in each status

statusobject or null

Current status of the work order

checklistlist of objects

Checklist items for the work order

workItemslist of objects

Work items linked to this work order via Blueprint workflow. Includes forms (FORM) and file requests (FILE_REQUEST). Returns [] when none are linked.

lineItemslist of objects

Present only for service work orders on an account (parent project type ACCOUNT), and only when at least one line item exists. Amounts are in dollars with cent precision. Replace via PUT /work-orders/{workOrderId}/line-items. Omitted from the response when not applicable or when there are no line items.

Errors

401

Unauthorized Error

404

Not Found Error