FieldEdge Open API
DocsAPIs
DocsAPIs
  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
    • Search customers by phone, email, or first name
      GET
    • Search customers based on address details.
      GET
    • Get customer details by ID
      GET
    • Updates an existing customer
      PUT
  • Webhook
    • Registers a new webhook endpoint to receive event notifications.
      POST
DocsAPIs
DocsAPIs
  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.

Request

Path Params

Responses

🟢200
application/json
Lead details retrieved successfully.
Body

🟢204
🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://dev.api.fieldedge.com/leads/v1/leads/'
Response Response Example
200 - 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-02-26 12:18:17
Previous
Creates a new lead with customer details, appointment preferences, and service information.
Next
Creates a new customer
Built with