Retrieve 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. Supports pagination via query parameters offset (default 0) and limit (default 20).

Request

Query Params

Responses

🟢200

application/json

Customers retrieved successfully

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://dev.api.fieldedge.com/open-api/v1/customers/search?phone=undefined&email=undefined&firstName=undefined&offset=undefined&limit=undefined'

Response Example

200 - response

{
    "total": 1,
    "limit": 20,
    "offset": 0,
    "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"
        }
    ]
}

Modified at 2026-05-21 10:40:18

Updates an existing customer

Retrieve customer details by ID