Retrieve a work order by ID

GET

/v1/work-orders/{workOrderId}

Retrieves full details of a work order including status, assignments, service address, task information, tags, and linked invoice.

Request

Authorization

Path Params

Responses

🟢200

application/json

Work order retrieved successfully.

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://dev.api.fieldedge.com/open-api/v1/work-orders/'

Response Example

200 - response

{
    "workOrderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "WO-10042",
    "workDescription": "Annual HVAC maintenance and filter replacement.",
    "resolution": "WorkPerformed",
    "completed": true,
    "customerId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "billingCustomerId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "serviceAddress": {
        "addressLine1": "123 Main St",
        "addressLine2": "Suite 100",
        "city": "Austin",
        "state": "TX",
        "postalCode": "78701"
    },
    "workOrderInformation": {
        "taskName": "HVAC Maintenance",
        "scheduledStart": "2026-04-20T08:00:00Z",
        "scheduledEnd": "2026-04-20T10:00:00Z",
        "completedDate": "2026-04-20T09:45:00Z",
        "assignedMinutes": 120,
        "priority": "High",
        "notes": "Customer requested early morning slot."
    },
    "tags": [
        "HVAC",
        "Maintenance"
    ],
    "primaryAssignment": {
        "employeeId": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "name": "Jane Smith"
    },
    "invoiceId": "e5f6a7b8-c9d0-1234-efab-345678901234"
}

Modified at 2026-05-21 10:40:18

Retrieve company name by ID

Retrieve an invoice by ID