Docs

Les fiches client, par partenaire

  • Dans le bac à sable
GET
/clients

Depuis la 0.24.0 (C14). La clé de l’opérateur ou la clé d’opérateur en lecture seule ; depuis la 0.25.0 une clé de partenaire, qui obtient la liste de son propre partenaire (nommer un autre partner répond 403). Les fiches définies avec PUT /clients/{client}/profile, par identifiant de client en ordre d’octets, 500 à la fois. Quand truncated vaut true, next est le dernier identifiant de la page, et after= suivi de cet identifiant lit la page suivante. partner restreint la liste aux clients d’un partenaire. Un client qui a des clés mais pas de fiche n’est pas listé.

Autorisation

apiKey
headerAuthorizationBearer <token>

Envoyez votre clé sous forme de jeton bearer : Authorization: Bearer <your-api-key>. L’état du service est le seul appel qui ne nécessite pas de clé.

Paramètres de requête

partner?string
Motif^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
after?string
Motif^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

Corps de la réponse

Les fiches.

application/json
  1. response
data*array<>
truncated*boolean
next?string

Le dernier identifiant de client de cette page ; présent seulement quand la liste est tronquée.

curl -X GET "https://example.com/clients" \  -H "Authorization: Bearer <your-api-key>"
{  "data": [    {      "client": "string",      "name": "string",      "partner": "string",      "stage": "pilot",      "contact_email": "string",      "legal_entities": [        "string"      ],      "countries": [        "string"      ],      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "truncated": true,  "next": "string"}