Skip to main content
GET
Get a client

Authorizations

Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

client_id
string
required

Response

The Client.

id
string
required
Example:

"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"

created_at
string<date-time>
required
external_id
string | null

Your own identifier for this user. Stored as sent and returned on every read, so you can join our Clients back to your records without keeping a mapping table. Filter on it with GET /v3/clients?external_id=. Null when you never set one.

Maximum string length: 255
email
string<email> | null
name
string | null
phone
string | null

Contact phone number for the client.

metadata
object | null

Free-form string key-value pairs for your own use, stored as sent and returned on every read. At most 20 keys. Null when you never set any.

updated_at
string<date-time>