GET
/
api
/
users

​
Additional information.

If no value is entered for any filter, the current user information is returned.

Authorizations

x-api-key
string
headerrequired

Query Parameters

type
enum<string>

Type of user by which you want to filter.

Available options:
business,
individual
brokerId
string

Id of the broker for which you want to get the list of users.

search
string

Allows you to search for any text.

authId
string

Id of the user for which you want to get the list of users.

firstName
string

First name of the individual to be searched.

lastName
string

Last name of the individual to be searched.

businessName
string

Name of the business to be searched.

onboardingStatus
enum<string>

Individual or business onboarding status.

Available options:
approved,
individualPassed,
individualReview,
individualFailed,
legalRepresentativeApproved,
legalRepresentativeFailed,
bridgeToSAndKYCCompleted,
bridgeKYCCompleted,
bridgeKYCApproved,
bridgeToSCompleted,
started,
failed,
review,
none
page
integer

Used to specify the current page you want to get in the paging results.

limit
integer

Used to specify the maximum number of records to be returned on a single page.

Response

200 - application/json
individualData
object
createdAt
string

Creation date of the user.

type
enum<string>

Type of the user.

Available options:
business,
individual
email
string

Email of the user.

attributes
enum<string>[]
Available options:
disabled,
banned,
broker,
brokerCustomer,
summedVolumeFees,
noReissueQuoteAfterExpiration,
prepaidOrders,
hasTransfersEnabled,
noVolatilityError,
brokerFeesEnabled,
canUploadKYCReportFile,
shortQuote,
needsAddressApproval,
canPriceMatch,
doNotSendOrderConfirmationEmail,
doNotSendOnboardingEmails
brokerId
string

Broker ID of the user.

onboarding
object
id
string

ID of the user.

Get userGet transaction limits for the current user