Investors, warrants & staking
Get Sub Investor
Returns one sub-investor's profile, login email, revokedAt and permissions by roleInOrgID.
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/tga/get-sub-investor?roleInOrgID=%3CroleInOrgID%3E' \
--header 'Authorization: Bearer <token>'{
"personID": "string",
"roleInOrgID": "string",
"invitedByInvestorID": "string",
"givenName": "string",
"familyName": "string",
"email": "string",
"revokedAt": "string",
"permissions": [
{
"permissionName": "EXERCISE_WARRANT",
"permissionDescription": "string",
"scope": "string"
}
]
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Query parameters
roleInOrgIDstringrequiredNOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it
Response
200Successful response
personIDstringrequiredAllowed: matches ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
roleInOrgIDstringAllowed: matches ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
invitedByInvestorIDstringrequiredgivenNamestringrequiredfamilyNamestringrequiredemailstring | nullrequiredrevokedAtstring | nullrequiredAllowed: matches ^(?:\d{4}|[+-]\d{6})-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-9]))T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}Z$
permissionsobject[]Show child attributes
permissionNamestringrequiredAvailable options: EXERCISE_WARRANT, VIEW_INVESTMENT, VIEW_WARRANT
permissionDescriptionstringscopestringrequired