API Reference

List client brokers

get
https://api.kalepa.com/external/client-brokers

List your client brokers, paginated and filterable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
≥ 1
Defaults to 1

1-indexed page number to fetch.

int32
1 to 100
Defaults to 100

Number of items per page (max 100).

string

Limit the request to this org group. Omit it to use all records your API client can access.

string

Limit the request to this sub org group. Omit it to use all sub org groups.

string
length ≥ 1

Exact-match filter on client_broker_id (the broker resource's natural-key field). Must be a non-empty string.

string

Exact-match filter on status.

string

Exact-match filter on code.

string

Exact-match filter on email.

Responses

401

The bearer token is missing or invalid.

403

The bearer token is missing or invalid.

500

An unexpected error occurred.

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago