FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Lead
  • 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
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
    • Retrieve availability of an item across one or more warehouses
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
    • Assign a technician to a work order
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
    • Retrieve an invoice by ID
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
    • Retrieve a list of tasks
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. Lead

Fetches lead details based on the provided lead identifier.

GET
/v1/leads/{leadId}
Retrieves the details of a lead by its unique identifier.
Required scope: leads:read

Request

Authorization
Path Params

Responses

🟢200
application/json
Lead details retrieved successfully.
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/leads/'
Response Response Example
200 - Example detailed lead response
{
    "data": {
        "leadId": "c1e2d5b0-873b-4f33-9f4c-9b06fb2cd401",
        "trackingId": "track-98765",
        "source": "web",
        "status": "InProcess",
        "preferredContactMethod": "Phone",
        "metaData": {
            "campaign": "FallPromo2025",
            "leadSource": "HomepageBanner"
        },
        "customer": {
            "customerId": "c82bd0d3-55e5-4e45-a3d0-4281aadb24f8",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@email.com",
            "phone": "1234567890",
            "marketingEmailOptedIn": true,
            "address": {
                "clientAddressRef": "ADDR-2001",
                "addressLine1": "123 Elm Street",
                "addressLine2": "Suite 5",
                "city": "Miami",
                "state": "FL",
                "postalCode": "33101",
                "country": "USA"
            }
        },
        "serviceRequest": {
            "serviceCategory": "HVAC",
            "serviceType": "AC Repair",
            "issueDescription": "Air conditioner does not cool.",
            "image": "base64encodedstringhere",
            "urgency": 2
        },
        "appointment": {
            "preferredDate": "2025-07-24",
            "preferredTime": "16:24",
            "timezone": "UTC",
            "availabilityNotes": "Available between 3–6 PM",
            "location": {
                "clientAddressRef": "ADDR-5678",
                "addressLine1": "456 Service Ave",
                "addressLine2": "Floor 2",
                "city": "Orlando",
                "state": "FL",
                "postalCode": "32801",
                "country": "USA"
            }
        },
        "accountId": "d4c4adfb-1413-4845-86b8-d07eebaae8f1"
    }
}
Modified at 2026-08-27 11:27:54
Previous
Creates a new lead with customer details, appointment preferences, and service information.
Next
Creates a new customer
Built with