List Customers

Use this endpoint to list customers for your organization.

Overview

This endpoint returns customer accounts, locations, and billing relationships that match the supplied filters. Use it to sync CRM, billing, dispatch, and customer lookup workflows.

Filters are partial matches where supported, so name=Acme can match a broader set of customer records. Archived customers are not returned.

By default the response includes exact total and totalPages counts. For large lists, pass includeCount=false to skip the count: total and totalPages are then null and meta.hasNextPage tells you whether another page exists.

What's Next

  • Use GET /customers/{id} to retrieve a selected customer.
  • Use POST /customers to create a new customer before creating services.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Case-insensitive partial email match.

string

Case-insensitive partial customer name match.

string

Partial phone match.

boolean

Filter parent customer records.

string

Return only child customers of this parent customer ID.

Free-text search across customer details.

string
enum

Set to services to include each customer's linked services in a services array.

Allowed:
boolean
Defaults to true

Set to false to skip the total count. meta.total and meta.totalPages are then null and meta.hasNextPage is returned.

integer
≥ 1
Defaults to 1

Page number.

integer
1 to 100
Defaults to 50

Results per page.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json