List customers

Retrieve a paginated list of customers with filtering and search capabilities. Includes full address information and delivery location count. Supports global search across all customer fields, delivery locations, contacts, and tags.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by multiple tags (at least one tag must be present). Format: comma-separated tag IDs (e.g., "1,2,3")

string

Filter by billing city (case-insensitive partial match)

string

Filter by billing country (ISO country code, e.g., "FR", "BE", "US")

string

Filtrer par code postal de facturation

string

Filtrer par nom d'entreprise

date-time

Clients créés après cette date

date-time

Clients créés avant cette date

string

Filter by customer type: "individual" for personal customers, "company" for business customers

string

Filtrer par nom d'affichage (contient)

string

Filtrer par email (contient)

string

Filtrer par ID externe

string

Filtrer par référence externe

string

Filtrer par prénom

boolean

Clients avec/sans ID externe

boolean

Clients avec/sans référence externe

boolean

Filter customers that have at least one delivery location (true) or no locations (false)

boolean

Clients avec/sans SIRET

boolean

Clients avec/sans numéro de TVA

boolean

Filter by active status. Only active customers are included in routing and delivery operations.

string

Filtrer par nom de famille

number

Nombre maximum de lieux de livraison

number

Nombre minimum de lieux de livraison

string

Order results by field. Use "-" prefix for descending order. Available fields: company_name, first_name, last_name, created_at, updated_at, customer_type, billing_city. Example: "company_name" or "-created_at"

integer

A page number within the paginated result set.

string

Filtrer par téléphone (contient)

string

Global search across all fields: company name, first name, last name, email, phone, SIRET, external ID, external reference, billing addresses, delivery locations, contacts, and tags. Searches in both customer and associated delivery location data.

string

Filtrer par SIRET

integer

Filter by specific tag ID. Returns customers that have this tag assigned.

string

Filter by tag name (partial match, case-insensitive)

string

Filter by multiple tags (all tags must be present). Format: comma-separated tag IDs (e.g., "1,2,3")

string

Filtrer par numéro de TVA

Responses

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