Lister les clients
Lister les clients
Aperçu
Lister les clients
Renvoie tous les clients de l'organisation du marchand authentifié. Filtres possibles : recherche, type de client et statut d'activité.
Quand l’utiliser
Utilisez cet endpoint quand vous devez exécuter GET /customers (Lister les clients).
Authentification
Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.
Endpoint
GET /customers
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres d’URL
Pas d’autre paramètre dans l’URL.
Paramètres de requête
| Nom | Emplacement | Obligatoire | Schéma | Description |
|---|---|---|---|---|
pageSize | query | Non | - | Nombre d'éléments par page |
page | query | Non | - | Numéro de page |
status | query | Non | - | Filtrer par activité (active = au moins une transaction, inactive = aucune transaction) |
type | query | Non | - | Filtrer par type de client |
search | query | Non | - | Recherche par nom ou e-mail |
En-têtes
| Nom | Emplacement | Obligatoire | Schéma | Description |
|---|---|---|---|---|
Lomi-Account | header | Non | - | Optional lomi. Network account id (acct_...). When present, the API key acts as the Operator and the request targets the connected Member Account. |
Réponses
| Statut | Description |
|---|---|
200 | Liste paginée de clients |
401 | Clé API invalide ou manquante |
Erreurs
Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.
Exemple
curl -sS -X GET "https://sandbox.api.lomi.africa/customers?pageSize=1&page=1" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
CustomersController_findAll - Operation:
GET /customers
Schémas complets et Try it : référence API.