# Lister les clients

`GET https://api.payiz.app/v1/customers`

Demande une clé secrète qui porte le geste « Clients · lire ».

Vos clients, du plus récent au plus ancien.

La recherche porte sur le nom, l’adresse et le numéro — celui-ci par son empreinte : il n’est jamais en clair en base.

## Ce qu'on met dans l'adresse

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `search` | texte | — | Un nom, une adresse, ou un numéro — celui-ci retrouvé par son empreinte. |
| `archived` | « true » · « false » | — | « true » : les archivés, et eux seuls. Par défaut, les autres. |
| `limit` | entier | — | De 1 à 100. Par défaut 20. |
| `starting_after` | texte | — | L’identifiant de la dernière ligne lue : la page suivante commence après. |

## Ce qu'on reçoit

`200` · une liste d’objets `customer`

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `object` | « list » | — | Le genre de l’objet rendu : il ne change jamais. |
| `data` | liste d’objets customer | — | Les clients de la page, du plus récent au plus ancien. |
| `has_more` | vrai ou faux | — | Vrai : il en reste. Rappelez avec starting_after sur la dernière ligne lue. |
| `url` | texte | — | L’adresse qui a servi, sans les filtres. |

## La demande

```bash
curl -G https://api.payiz.app/v1/customers \
  -H "Authorization: Bearer sk_test_…" \
  -d search=awa
```

## La réponse

```json
{
  "object": "list",
  "url": "/v1/customers",
  "has_more": false,
  "data": [
    {
      "object": "customer",
      "id": "cli_01j9xn4rt6m8wqv2hc5d",
      "name": "Awa Houénou",
      "email": "awa.h@exemple.bj",
      "phone": "+229 01 •• •• 21 07",
      "country": "BEN",
      "note": "Cliente depuis juin.",
      "archived_at": null,
      "created": 1789826492,
      "livemode": false
    }
  ]
}
```