List customers
List customers
Overview
List customers
Returns a paginated customer directory with optional filters such as search text and activity.
When to use this
Use for CRM-style search, back-office lists, and exporting buyer records.
Authentication
Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.
Endpoint
GET /customers
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
No path parameters beyond the URL pattern.
Query parameters
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
pageSize | query | No | - | Nombre d'éléments par page |
page | query | No | - | Numéro de page |
status | query | No | - | Filtrer par activité (active = au moins une transaction, inactive = aucune transaction) |
type | query | No | - | Filtrer par type de client |
search | query | No | - | Recherche par nom ou e-mail |
Headers
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
Lomi-Account | header | No | - | Optional lomi. Network account id (acct_...). When present, the API key acts as the Operator and the request targets the connected Member Account. |
Responses
| Status | Description |
|---|---|
200 | Success |
401 | Invalid or missing API key |
Errors
Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.
Example
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
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.