Customers

Using the Customer API 

The Customer API helps you find and retrieve customer records in FieldEdge. You can use it to: 

• Look up customers by phone, email, or first name 

• Find customers using a full address 

• Retrieve a customer using a known customer ID 

All Customer API endpoints are read-only and return JSON. 

Find Customers by Phone, Email, or First Name 

Use this endpoint when you want to search using common identifiers like phone or email. 

GET /v1/customers/search 

Optional query parameters 

• phone 

• email 

• firstName 

You can provide one or more parameters. 

Find Customers by Address 

Use this endpoint when you have a full address and want to find customers at that location. 

GET /v1/customers/by-address 

Required query parameters 

• addressLine1 

• city 

• stateOrRegion 

• postalCode 

Optional query parameters 

• addressLine2

Get Customer Details by Customer ID 

Use this endpoint when you already know the customer ID and want the full customer record. 

GET /v1/customers/id/{customerId} 

Tips 

• If you have a customer ID, use the Get by Customer ID endpoint for the most direct result. 

• If you’re not sure who the customer is, start with Search (phone/email). 

• When contacting support, include the requestId from the error response.