Get a client record

GET

/clients/{id}

• Production

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string

Client ID

Responses

200

Client record

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

401

Missing or invalid API key

object

code

string

message

string

statusCode

integer

Example

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

404

Resource not found

object

code

string

message

string

statusCode

integer

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found.",
  "statusCode": 404
}

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