Search for customers in the tenant

Returns customers matching the supplied filters. If fields=customerId is passed, only the customerId of each match is returned without requiring full-profile read permissions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
Query Params
string

Account number for any wallet. If it is passed then it will ignore other fields

string
int64
string
string
string

Field data to include. Comma separated list. Supports customerId or positions.

string
string
boolean
string
int32
Defaults to 50
string
int32
Defaults to 0
boolean
Defaults to false

When the parameter is set to true, Only the customers that the user has permission to access will be returned. However, if the parameter is set to false and the user does not have permission, will result in an error being thrown.

string
string
string
int32
int64
Responses

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