Retrieve customers based on address details.

GET

/v1/customers/by-address

Search and retrieve customers by address information. Supports pagination via query parameters offset (default 0) and limit (default 20).

Required scope: customers:read

Request

Query Params

Responses

🟢200

application/json

Customers retrieved successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://dev.api.fieldedge.com/open-api/v1/customers/by-address?addressLine1=&addressLine2=&city=&stateOrRegion=&postalCode=&offset=&limit=&sort='

Response Example

200 - response

{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "customers": [
        {
            "customerId": "c82bd0d3-55e5-4e45-a3d0-4281aadb24f8",
            "firstName": "John",
            "lastName": "Doe"
        },
        {
            "customerId": "a7b2d1e3-5f89-4b1d-9a6e-2c9b8f2a0b44",
            "firstName": "Jane",
            "lastName": "Smith"
        }
    ]
}

Modified at 2026-07-01 10:25:15

Retrieve customer details by ID

Retrieve customer by phone number