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 utiliser cet endpoint
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 Aperçu de l’intégration). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.
Point de terminaison
GET /customers
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres de chemin
Aucun paramètre de chemin au-delà du motif d’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 |
Réponses
| Statut | Description |
|---|---|
200 | Liste paginée de clients |
401 | Clé API invalide ou manquante |
Erreurs
Les erreurs suivent le format JSON standard (code de statut et message lisible par machine). Validez les entrées avant appel ; 401 indique une clé manquante/invalide, 404 une ressource introuvable pour cette organisation, 429 une limitation de débit. Pour les retries sûrs sur les créations, envoyez une clé d’idempotence quand votre flux le permet.
Exemple
curl -sS -X GET "https://sandbox.api.lomi.africa/customers?pageSize=1&page=1" \
-H "X-API-KEY: $LOMI_API_KEY"OpenAPI
- operationId:
CustomersController_findAll - Operation:
GET /customers
Schémas complets et Try it : référence API. Contrat machine : openapi.json à la racine des docs.