Axiym

List clients

Returns client records associated with your partnership, including clients that are ONBOARDING, ACTIVE, or DISABLED. Use a returned clientId in Trade API resource paths only when its status is ACTIVE. Retrieve rejected onboarding cases through GET /onboardings/{clientId}.

Authorization

Default
AuthorizationBearer <token>

In: header

Query Parameters

first?integer

Maximum number of items to return (page size).

Range1 <= value <= 100
Default20
after?string

Cursor for the next page, from the previous response's pageInfo.endCursor.

searchQuery?string

Filter clients by name, Axiym client code, or your partnerClientId.

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json