Investors, warrants & staking

Get Sub Investor

Returns one sub-investor's profile, login email, revokedAt and permissions by roleInOrgID.

GEThttps://api.toku.com/tga/get-sub-investor

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/tga/get-sub-investor?roleInOrgID=%3CroleInOrgID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "personID": "string",
  "roleInOrgID": "string",
  "invitedByInvestorID": "string",
  "givenName": "string",
  "familyName": "string",
  "email": "string",
  "revokedAt": "string",
  "permissions": [
    {
      "permissionName": "EXERCISE_WARRANT",
      "permissionDescription": "string",
      "scope": "string"
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

Bearer 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

roleInOrgIDstringrequired

NOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it

Response

200Successful response
personIDstringrequired

Allowed: 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}$

roleInOrgIDstring

Allowed: 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}$

invitedByInvestorIDstringrequired
givenNamestringrequired
familyNamestringrequired
emailstring | nullrequired
revokedAtstring | nullrequired

Allowed: 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
permissionNamestringrequired

Available options: EXERCISE_WARRANT, VIEW_INVESTMENT, VIEW_WARRANT

permissionDescriptionstring
scopestringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits