FieldEdge Open API
DocsAPIs
DocsAPIs
  1. Customer
  • 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. Customer

Search customers by phone, email, or first name

GET
/v1/customers/search
Retrieves customers that match one or more of the provided search criteria: phone number, email address, or first name.

Request

Query Params

Responses

🟢200
application/json
Customers 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/customers/search?phone&email&firstName'
Response Response Example
200 - response
{
    "customers": [
        {
            "id": "c9a1f6c2-8c2b-4c91-9f7b-2e5b8b0d3a01",
            "firstName": "John",
            "lastName": "Doe",
            "companyName": "Acme Heating Services",
            "displayName": "John Doe - Acme Heating Services",
            "address1": "123 Main St",
            "address2": "Suite 200",
            "city": "Dallas",
            "state": "TX",
            "zip": "75201",
            "billingAddress1": "123 Main St",
            "billingAddress2": "Suite 200",
            "billingCity": "Dallas",
            "billingState": "TX",
            "billingZip": "75201",
            "primaryPhone": "+1-214-555-0198",
            "primaryEmail": "john.doe@acmeheating.com",
            "contactOnPhone": true,
            "contactOnSms": true,
            "contactOnEmail": true,
            "active": true,
            "billFromOffice": false,
            "parentCustomerId": "a7b2d1e3-5f89-4b1d-9a6e-2c9b8f2a0b44",
            "hasServiceAgreement": true,
            "agreementId": "sa-4e6d9b12-98a4-41e2-bc2f-91f3e61c3b55"
        }
    ]
}
Modified at 2026-02-26 12:18:17
Previous
Creates a new customer
Next
Search customers based on address details.
Built with