> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/api-reference/work-orders/get-work-order/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# Get Work Order

GET https://api.coperniq.io/v1/work-orders/{work_order_id}

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.


Reference: https://docs.coperniq.io/api-reference/work-orders/get-work-order

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `work_order_id` (integer, required) — Work order identifier

## Response

### 200

Work order details

- `id` (integer, optional) — Work order identifier
- `uid` (integer, optional) — Unique work order number within the project
- `templateId` (integer, optional) — Template identifier for the work order
- `createdAt` (string, optional) — Creation timestamp
- `updatedAt` (string, optional) — Last update timestamp
- `title` (string, optional) — Work order title
- `description` (string, optional) — Work order description
- `priority` (integer, optional) — Priority level
- `startDate` (string, optional, nullable) — Scheduled start date
- `startDateAllDay` (boolean, optional) — Whether the start date is an all-day event
- `endDate` (string, optional, nullable) — Scheduled end date
- `endDateAllDay` (boolean, optional) — Whether the end date is an all-day event
- `completedAt` (string, optional, nullable) — Timestamp when the work order was completed
- `isActive` (boolean, optional) — Whether the work order is active (not archived)
- `isCompleted` (boolean, optional) — Whether the work order is completed
- `isField` (boolean, optional) — Whether the work order is a field task
- `labels` (list of WorkOrderLabelsItems, optional) — Labels associated with the work order
- `project` (WorkOrderProject, optional) — Project associated with the work order
- `assignee` (WorkOrderAssignee, optional, nullable) — User assigned to the work order
- `collaborators` (list of UserSummary, optional) — Additional users collaborating on the work order
- `visits` (WorkOrderVisits, optional) — Site visits associated with the work order (legacy shape)
- `statuses` (list of WorkOrderStatusesItems, optional) — History of status changes and time spent in each status
- `status` (WorkOrderStatus, optional, nullable) — Current status of the work order
- `checklist` (list of ChecklistItem, optional) — Checklist items for the work order
- `workItems` (list of WorkOrderWorkItem, optional) — Work items linked to this work order via Blueprint workflow. Includes forms (`FORM`) and file requests (`FILE_REQUEST`). Returns [] when none are linked.
- `lineItems` (list of WorkOrderLineItem, optional) — 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.
- `isArchived` (boolean, optional, deprecated) — Deprecated: use `isActive` instead. Kept for backward compatibility.

## Errors

### 401 Unauthorized Error

Authentication failed

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

### 404 Not Found Error

Resource not found

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

## Types

### WorkOrderLabelsItems

- `label` (WorkOrderLabelsItemsLabel, optional)

### WorkOrderProject

Project associated with the work order

- `id` (integer, optional) — Project identifier
- `uid` (integer, optional) — Project number
- `title` (string, optional) — Project title
- `address` (list of string, optional) — Project address
- `stage` (string, optional, nullable) — Project stage (if available)

### WorkOrderAssignee

User assigned to the work order

- `id` (integer, optional) — User identifier
- `firstName` (string, optional) — User's first name
- `lastName` (string, optional) — User's last name
- `email` (string, optional) — User's email address

### UserSummary

Minimal user representation used in responses

- `id` (integer, optional)
- `firstName` (string, optional, nullable)
- `lastName` (string, optional, nullable)
- `email` (string, optional, nullable)
- `avatarUrl` (string, optional, nullable)

### WorkOrderVisits

Site visits associated with the work order (legacy shape)

- `visits` (list of Visit, optional) — List of visits

### WorkOrderStatusesItems

- `count` (string, optional) — Number of times this status was entered
- `endedAt` (string, optional) — When the status ended
- `spentTime` (double, optional) — Time spent in this status in seconds
- `startedAt` (string, optional) — When the status started
- `status` (string, optional) — Status identifier

### WorkOrderStatus

Current status of the work order

- `id` (string, optional, nullable) — Status identifier
- `label` (string, optional, nullable) — Human readable status label

### ChecklistItem

- `id` (integer, optional) — Checklist item identifier
- `detail` (string, optional) — Checklist task detail
- `isCompleted` (boolean, optional) — Whether the checklist item is completed
- `completedAt` (string, optional, nullable) — Completion timestamp, if completed

### WorkOrderWorkItem

- `type`: `FORM` (FORM)
  - `id` (integer, required) — Form instance ID
  - `completedAt` (string, optional, nullable)
  - `dueDate` (string, optional, nullable) — Due date ISO string
  - `isCompleted` (boolean, optional)
  - `name` (string, optional, nullable) — Form name
  - `status` (string, optional, nullable) — Form status (e.g. OPEN, IN_PROGRESS, COMPLETED)
  - `templateId` (integer, optional, nullable) — Template the form was created from
- `type`: `FILE_REQUEST` (FILE_REQUEST)
  - `id` (integer, required) — Action instance ID
  - `name` (string, optional, nullable) — File request title
  - `status` (string, optional, nullable) — Element instance status (e.g. OPEN, IN_PROGRESS, COMPLETED)

### WorkOrderLineItem

- `id` (integer, optional)
- `quantity` (integer, optional)
- `description` (string, optional, nullable)
- `unitCost` (double, optional)
- `totalCost` (double, optional, nullable)
- `unitPrice` (double, optional)
- `totalPrice` (double, optional, nullable)
- `sectionName` (string, optional, nullable)
- `catalogItem` (WorkOrderLineItemCatalogItem, optional, nullable)

### WorkOrderLabelsItemsLabel

- `id` (integer, optional) — Label identifier
- `label` (string, optional) — Label name
- `color` (string, optional) — Label color (hex code)

### Visit

Only applicable on field work orders.

- `id` (integer, optional) — Visit identifier
- `description` (string, optional, nullable)
- `startDate` (string, optional, nullable)
- `endDate` (string, optional, nullable)
- `startDateAllDay` (boolean, optional, default: false)
- `endDateAllDay` (boolean, optional, default: false)
- `isCompleted` (boolean, optional)

### WorkOrderLineItemCatalogItem

- `id` (integer, optional)
- `name` (string, optional)
- `sku` (string, optional, nullable)
- `type` (string, optional, nullable)
- `manufacturer` (string, optional, nullable)

## Examples

**Response**

```json
{
  "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,
  "isActive": true,
  "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"
  },
  "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"
    }
  ],
  "isArchived": false
}
```

**SDK Code**

```python Work Orders_getWorkOrder_example
import requests

url = "https://api.coperniq.io/v1/work-orders/1"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Work Orders_getWorkOrder_example
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);
}
```

```go Work Orders_getWorkOrder_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/work-orders/1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Work Orders_getWorkOrder_example
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/work-orders/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Work Orders_getWorkOrder_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/work-orders/1")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Work Orders_getWorkOrder_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/work-orders/1', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Work Orders_getWorkOrder_example
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/work-orders/1");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Work Orders_getWorkOrder_example
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/work-orders/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> Official Coperniq API documentation. Build integrations for solar and construction project management — projects, opportunities, work orders, invoices, webhooks, and more.