Docs

De eindklantrecords, per partner

  • In de sandbox
GET
/clients

Sinds 0.24.0 (C14). De sleutel van de beheerder of de alleen-lezen beheerderssleutel; sinds 0.25.0 een partnersleutel, die de lijst van de eigen partner krijgt (een andere partner noemen geeft 403). De records die met PUT /clients/{client}/profile zijn ingesteld, op eindklant-id in bytevolgorde, 500 per keer. Als truncated waar is, is next het laatste id van de pagina, en after= dat id leest de volgende pagina. partner beperkt de lijst tot de eindklanten van één partner. Een eindklant met sleutels maar zonder record staat niet in de lijst.

Autorisatie

apiKey
headerAuthorizationBearer <token>

Stuur uw sleutel als bearer-token: Authorization: Bearer <your-api-key>. De health-aanroep is de enige aanroep die geen sleutel vereist.

Queryparameters

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

Body van het antwoord

De records.

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

Het laatste eindklant-id van deze pagina; alleen aanwezig als de lijst is afgekapt.

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"}