Retrieve a paginated list of work orders

GET

/v1/work-orders

Returns a paginated and sortable list of work orders for the authenticated company. Use offset and limit to page through results. Use sort to control ordering. Use completed, customerId, invoiceAdded, primaryTechEntityId, and assigned to filter. Filters combine with AND semantics. assigned=false cannot be combined with primaryTechEntityId and returns 400 CONTRADICTORY_ASSIGNMENT_FILTER.

Required scope: workorders:read

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Work orders retrieved successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.fieldedge.com/open-api/v1/work-orders?offset=&limit=&sort=&completed=&customerId=&invoiceAdded=&primaryTechEntityId=&assigned=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Paginated list of work orders

{
    "total": 47,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "workOrderId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
            "workOrderNumber": "WO-1001",
            "completed": false,
            "resolution": "",
            "customerId": "c1d2e3f4-0000-0000-0000-aabbccddeeff",
            "billingCustomerId": "b1c2d3e4-0000-0000-0000-112233445566",
            "serviceAddress": {
                "addressLine1": "123 Main St",
                "addressLine2": "",
                "city": "Orlando",
                "state": "FL",
                "postalCode": "32801"
            },
            "scheduledStart": "2026-06-10T08:00:00.0000000Z",
            "scheduledEnd": "2026-06-10T10:00:00.0000000Z",
            "priority": "High",
            "assignedMinutes": 120,
            "tags": [
                "urgent",
                "warranty"
            ],
            "primaryAssignment": {
                "employeeId": "a1b2c3d4-0000-0000-0000-111111111111",
                "name": "John Smith"
            },
            "invoiceId": null,
            "invoiceAdded": false,
            "primaryTechEntityId": "a1b2c3d4-0000-0000-0000-111111111111"
        },
        {
            "workOrderId": "a2b3c4d5-e6f7-8901-bcde-fa2345678901",
            "workOrderNumber": "WO-1002",
            "completed": true,
            "resolution": "WorkPerformed",
            "customerId": "d2e3f4a5-0000-0000-0000-bbccddee0011",
            "billingCustomerId": null,
            "serviceAddress": {
                "addressLine1": "456 Oak Ave",
                "addressLine2": "Suite 2",
                "city": "Tampa",
                "state": "FL",
                "postalCode": "33601"
            },
            "scheduledStart": "2026-06-08T09:00:00.0000000Z",
            "scheduledEnd": "2026-06-08T11:00:00.0000000Z",
            "priority": "Medium",
            "assignedMinutes": 90,
            "tags": [],
            "primaryAssignment": null,
            "invoiceId": "e3f4a5b6-0000-0000-0000-ccddee001122",
            "invoiceAdded": true,
            "primaryTechEntityId": null
        }
    ]
}

Modified at 2026-08-27 11:27:00

Retrieve list of sales tax codes

Retrieve a work order by ID