List clients

GET

/clients

• Production

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

search

string

Search by name, email, or externalId

memberType

string

Allowed values: individual business

active

string

Allowed values: true false

sort

string

Allowed values: name created_at request_count

page

integer

default: 1 >= 1

limit

integer

default: 20 >= 1 <= 100

Responses

200

Paginated list of clients

object

data

Array<object>

object

id

string

orgId

string

nameFirst

string

nullable

nameLast

string

nullable

businessName

string

nullable

email

string

nullable

phone

string

nullable

externalId

string

nullable

memberType

string

Allowed values: individual business

addressLine1

string

nullable

addressLine2

string

nullable

city

string

nullable

region

string

nullable

postalCode

string

nullable

country

string

nullable

metadata

object

active

boolean

requestCount

integer

createdAt

string format: date-time

updatedAt

string format: date-time

pagination

object

page

integer

limit

integer

total

integer

totalPages

integer

hasNext

boolean

hasPrev

boolean

401

Missing or invalid API key

object

code

string

message

string

statusCode

integer

Example

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API key.",
  "statusCode": 401
}

429

Too many requests

object

code

string

message

string

statusCode

integer

Example

{
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "statusCode": 429
}

Headers

Retry-After

integer

Seconds until the rate limit window resets

X-RateLimit-Limit

integer

X-RateLimit-Remaining

integer