Skip to main content
GET
Lister les clients d’un établissement

Autorisations

x-api-key
string
header
requis

Clé API d’établissement ou d’organisation.

Paramètres de chemin

location_id
string
requis

Paramètres de requête

limit
integer
défaut:10

Taille de page (1–100).

Plage requise: 1 <= x <= 100
starting_after
string

Retourne les clients après cet identifiant client.

ending_before
string

Retourne les clients avant cet identifiant client.

created_after
string<date-time>

Retourne les profils clients créés après cet horodatage ISO 8601.

created_before
string<date-time>

Retourne les profils clients créés avant cet horodatage ISO 8601.

updated_after
string<date-time>

Retourne les profils clients mis à jour après cet horodatage ISO 8601.

updated_before
string<date-time>

Retourne les profils clients mis à jour avant cet horodatage ISO 8601.

Retourne les clients ayant ce statut de consentement marketing. Une absence d’enregistrement correspond à unknown.

Options disponibles:
opted_in,
opted_out,
unknown
min_completed_orders
integer

Retourne les clients ayant au moins ce nombre de commandes terminées dans le périmètre de la route.

Plage requise: x >= 0

Réponse

Une liste paginée des clients de l’établissement.

object
enum<string>
requis
Options disponibles:
list
data
object[]
requis
has_more
boolean
requis
url
string
requis