List Account Work Orders

const url = 'https://api.coperniq.io/v1/accounts/1/work-orders';
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": 1,
    "uid": 1,
    "templateId": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "title": "string",
    "description": "string",
    "priority": 1,
    "startDate": "2024-01-15T09:30:00Z",
    "startDateAllDay": true,
    "endDate": "2024-01-15T09:30:00Z",
    "endDateAllDay": true,
    "completedAt": "2024-01-15T09:30:00Z",
    "isActive": true,
    "isCompleted": true,
    "isField": true,
    "labels": [
      {
        "label": {
          "id": 1,
          "label": "string",
          "color": "string"
        }
      }
    ],
    "project": {
      "id": 1,
      "uid": 1,
      "title": "string",
      "address": [
        "string"
      ],
      "stage": "string"
    },
    "assignee": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string"
    },
    "collaborators": [
      {
        "id": 1,
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "avatarUrl": "string"
      }
    ],
    "visits": {
      "visits": [
        {
          "id": 1,
          "description": "string",
          "startDate": "2024-01-15T09:30:00Z",
          "endDate": "2024-01-15T09:30:00Z",
          "startDateAllDay": false,
          "endDateAllDay": false,
          "isCompleted": true
        }
      ]
    },
    "statuses": [
      {
        "count": "string",
        "endedAt": "2024-01-15T09:30:00Z",
        "spentTime": 1.1,
        "startedAt": "2024-01-15T09:30:00Z",
        "status": "string"
      }
    ],
    "status": {
      "id": "string",
      "label": "string"
    },
    "checklist": [
      {
        "id": 1,
        "detail": "string",
        "isCompleted": true,
        "completedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "workItems": [
      {
        "type": "FILE_REQUEST",
        "id": 2556,
        "name": "Shade Report",
        "status": "IN_PROGRESS"
      }
    ],
    "lineItems": [
      {
        "id": 1,
        "quantity": 1,
        "description": "string",
        "unitCost": 1.1,
        "totalCost": 1.1,
        "unitPrice": 1.1,
        "totalPrice": 1.1,
        "sectionName": "string",
        "catalogItem": {
          "id": 1,
          "name": "string",
          "sku": "string",
          "type": "string",
          "manufacturer": "string"
        }
      }
    ],
    "isArchived": true
  }
]

Retrieve work orders for a specific account

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

account_idintegerRequired

Account identifier

Response

List of work orders

idintegerOptional

Work order identifier

uidintegerOptional

Unique work order number within the project

templateIdintegerOptional

Template identifier for the work order

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

titlestringOptional

Work order title

descriptionstringOptional

Work order description

priorityintegerOptional

Priority level

startDatestring or nullOptionalformat: "date-time"

Scheduled start date

startDateAllDaybooleanOptional

Whether the start date is an all-day event

endDatestring or nullOptionalformat: "date-time"

Scheduled end date

endDateAllDaybooleanOptional

Whether the end date is an all-day event

completedAtstring or nullOptionalformat: "date-time"

Timestamp when the work order was completed

isActivebooleanOptional

Whether the work order is active (not archived)

isCompletedbooleanOptional

Whether the work order is completed

isFieldbooleanOptional

Whether the work order is a field task

labelslist of objectsOptional

Labels associated with the work order

projectobjectOptional

Project associated with the work order

assigneeobject or nullOptional

User assigned to the work order

collaboratorslist of objectsOptional

Additional users collaborating on the work order

visitsobjectOptional

Site visits associated with the work order (legacy shape)

statuseslist of objectsOptional

History of status changes and time spent in each status

statusobject or nullOptional

Current status of the work order

checklistlist of objectsOptional

Checklist items for the work order

workItemslist of objectsOptional

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 objectsOptional

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/{work_order_id}/line-items. Omitted from the response when not applicable or when there are no line items.

isArchivedbooleanOptionalDeprecated

Deprecated: use isActive instead. Kept for backward compatibility.