FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. WorkOrder
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Search customers with optional filters
      GET
    • Retrieve customer details by ID
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer by phone number
      GET
  • Item Category
    • Retrieve list of item categories
      GET
    • Retrieve item category by id.
      GET
    • Create a new item category
      POST
    • Partially update an item category
      PATCH
  • Item
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Retrieve an inventory item by ID
      GET
    • Creates a new inventory item
      POST
    • Updates an existing inventory item
      PATCH
    • Bulk update inventory items
      PATCH
  • Warehouse
    • Create a new warehouse
      POST
    • Retrieve a paginated list of warehouses
      GET
    • Update an existing warehouse
      PATCH
    • Retrieve a warehouse by ID
      GET
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • WorkOrder
    • Retrieve a work order by ID
      GET
    • Retrieve a paginated list of work orders
      GET
    • Retrieve work orders at a given address
      GET
  • Invoice
    • Retrieve an invoice by ID
    • Retrieve a paginated list of invoices
  • Task
    • Retrieve a list of tasks
    • Retrieve a task bundle by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Rotate the HMAC signing secret for the registered webhook.
    • Delete the registered webhook for the authenticated account.
  1. WorkOrder

Retrieve work orders at a given address

GET
/v1/work-orders/by-address
Returns a paginated list of work orders matching the given address, sorted by work order date descending. Each work order includes the identifying name of its associated customer.
Required scope: workorders:read

Request

Authorization
or
Query Params

Responses

🟢200
application/json
Work orders retrieved successfully.
Bodyapplication/json

🟠400
🟠401
🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/work-orders/by-address?addressLine1=&addressLine2=&city=&stateOrRegion=&postalCode=&offset=&limit=&sort='
Response Response Example
200 - response
{
    "total": 3,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "workOrderId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
            "workOrderNumber": "WO-1003",
            "customerId": "d2e3f4a5-0000-0000-0000-bbccddee0011",
            "date": "2026-03-15T08:00:00Z",
            "address": {
                "address1": "123 Main St",
                "address2": "",
                "city": "Orlando",
                "state": "FL",
                "zip": "32801"
            },
            "customer": {
                "name": "Jane Doe",
                "firstName": "Jane",
                "lastName": "Doe"
            }
        },
        {
            "workOrderId": "a2b3c4d5-e6f7-8901-bcde-fa2345678901",
            "workOrderNumber": "WO-1002",
            "customerId": "c1d2e3f4-0000-0000-0000-aabbccddeeff",
            "date": "2025-08-10T09:00:00Z",
            "address": {
                "address1": "123 Main St",
                "address2": "",
                "city": "Orlando",
                "state": "FL",
                "zip": "32801"
            },
            "customer": {
                "name": "John Smith",
                "firstName": "John",
                "lastName": "Smith"
            }
        },
        {
            "workOrderId": "b3c4d5e6-f7a8-9012-cdef-ab3456789012",
            "workOrderNumber": "WO-1001",
            "customerId": "c1d2e3f4-0000-0000-0000-aabbccddeeff",
            "date": "2024-01-05T10:00:00Z",
            "address": {
                "address1": "123 Main St",
                "address2": "",
                "city": "Orlando",
                "state": "FL",
                "zip": "32801"
            },
            "customer": {
                "name": "John Smith",
                "firstName": "John",
                "lastName": "Smith"
            }
        }
    ]
}
Modified at 2026-07-09 08:21:27
Previous
Retrieve a paginated list of work orders
Next
Retrieve an invoice by ID
Built with