List customers

Retrieves a paginated list of all customers (contacts).

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number for pagination (default: 1)
limitintegerNoNumber of items per page (default: 50)
orderstringNoField to sort by (default: id)
directionstringNoSort direction: asc or desc (default: desc)

Response Fields

FieldTypeDescription
idintegerCustomer unique identifier
numberstringAuto-generated customer reference number
firstNamestringCustomer first name
lastNamestringCustomer last name
fullNamestringComputed full name (firstName + lastName)
emailstringCustomer email address
phonestringPrimary phone number
civilitystringCivility/title (Mr, Mrs, etc.)
jobTitlestringJob title/position
customerCompanyobjectLinked customer company (B2B)
billingAddressobjectBilling address
deliveryAddressobjectDelivery address if different
differentDeliveryAddressbooleanWhether delivery address differs from billing
customFieldsobjectCustom field values
archivedbooleanWhether the customer is archived
isDeletablebooleanWhether the customer can be deleted (no linked deals)
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Filtering

This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.

Quick examples:

?filters[firstName][contains]=John
?filters[email][endsWith][email protected]
?filters[customerCompany.name][contains]=Acme
?filters[customFields.source][eq]=website

Response

  • 200 OK: Returns paginated list of customers
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
integer
string
string
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!