Skip to main content
GET
Search for customers

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Query Parameters

partner_customer_id
string

The unique identifier for the customer in the partner's system The unique identifier for the customer in the partner's system.

Compared byte-for-byte, so PARTNER_USER_456 and partner_user_456 are two different customers. Send the same casing everywhere or a later lookup silently returns no match.

Restricted to printable ASCII (\x20\x7E) rather than arbitrary UTF-8: the value is propagated between internal services as an HTTP/2 header, which cannot carry non-ASCII bytes. The bound is published rather than discovered.

Required string length: 1 - 128
Pattern: ^[\x20-\x7E]+$
Example:

"PARTNER_USER_456"

limit
integer<int32>
default:10

Limits the number of returned results

Required range: x >= 1
starting_after
string

A cursor for use in pagination. An id that defines your place in the list.

Response

200 - application/json

List of customers

data
object[]
has_more
boolean
total
integer