Docs

Die Kundendatensätze, nach Partner

  • In der Sandbox
GET
/clients

Seit 0.24.0 (C14). Der Schlüssel des Betreibers oder der schreibgeschützte Betreiberschlüssel; seit 0.25.0 ein Partnerschlüssel, der die Liste des eigenen Partners erhält (ein anderer partner wird mit 403 beantwortet). Die mit PUT /clients/{client}/profile gesetzten Datensätze, nach Kunden-ID in Byte-Reihenfolge, je 500. Ist truncated wahr, ist next die letzte ID der Seite, und after= mit dieser ID liest die nächste Seite. partner beschränkt die Liste auf die Kunden eines Partners. Ein Kunde mit Schlüsseln, aber ohne Datensatz wird nicht aufgeführt.

Autorisierung

apiKey
headerAuthorizationBearer <token>

Senden Sie Ihren Schlüssel als Bearer-Token: Authorization: Bearer <your-api-key>. Der Systemzustand ist der einzige Aufruf, der keinen Schlüssel braucht.

Query-Parameter

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

Antwort-Body

Die Datensätze.

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

Die letzte Kunden-ID dieser Seite; nur vorhanden, wenn abgeschnitten.

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