Rechercher des destinataires

Recherche dans le carnet d'adresses.

Réponse exemple

{
  "data": [
    {
      "id": "rec_12345abcde",
      "name": "Alice Johnson",
      "tags": [
        "vip",
        "client"
      ],
      "email": "alice@example.com",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "object": "list",
  "next_cursor": "2026-01-14T14:22:00Z"
}

Recherche des destinataires par e-mail ou nom, avec pagination par curseur.

Authentification

Requiert une clé API avec le scope address_book:read.

Paramètres de requête

Paramètre	Type	Requis	Description
q	string	Oui	Terme de recherche (e-mail ou nom).
limit	integer	Non	Max de résultats (1 à 100, défaut 20).
cursor	string	Non	Curseur de pagination (`next_cursor` précédent).

Codes de statut

200 Résultats renvoyés.
400 q manquant.
403 Scope insuffisant.