Get clients report
GET/v1/partnership/reports/clients
Return client-level partner reporting data, including registration, activity, reward, rebate, KYC, deposit, balance, and contact-sharing attributes. This report does not return a list of the client’s trading accounts; use the Client accounts report for account-level rows.
Required scopes:
- read:
partnership.all:readorpartnership.all.
Rules:
- Use
limitandoffsettogether to paginate the result set. - Keep the same filter set and ordering while retrieving additional pages.
- When
trade_fn_fromortrade_fn_tois used, the report returns only clients with a positive reward.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
Consistency and recovery notes:
- This read operation can be retried. Results may change as report data is updated. Keep the same filters and ordering when reading additional pages, where pagination is supported.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationError
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 502
- 503
- 504
Successful response.
Bad request or validation error. The response uses either the numeric request-processing error response or the Partnership string-code error response.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.