Docs

The client records, by partner

  • In the sandbox
GET
/clients

Since 0.24.0 (C14). The operator's key or the read-only operator key; since 0.25.0 a partner key, which gets its own partner's list (naming another partner answers 403). The records set with PUT /clients/{client}/profile, by client id in byte order, 500 at a time. When truncated is true, next is the last id of the page, and after= that id reads the next page. partner narrows the list to one partner's clients. A client with keys but no record is not listed.

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.

Query parameters

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

Response body

The records.

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

The last client id of this page; present only when truncated.

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