Identity, people & notifications
Get Grants For Employee
Lists an employee non-SCP grants with vestings and projected vested/unvested units at an optional termination date.
Not available to API keys yet. It will need grants:read.
curl --request GET \
--url 'https://api.toku.com/platform/get-grants-for-employee?employeeRoleInOrgID=%3CemployeeRoleInOrgID%3E' \
--header 'Authorization: Bearer <token>'[
{
"grantID": "string",
"grantName": "string",
"grantAmount": "string",
"grantDate": "string",
"grantStatus": "PENDING",
"tokenType": "string",
"vestings": [
{
"vestingID": "string",
"vestingDate": "string",
"status": "PENDING",
"vestedUnits": "string",
"sequence": 0
}
],
"projectedVestedUnits": "string",
"projectedUnvestedUnits": "string",
"totalVestedUnits": "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
employeeRoleInOrgIDstring<uuid>requiredterminationDatestringNOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it
Response
200Successful response
grantIDstringrequiredgrantNamestringrequiredgrantAmountstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
grantDatestringrequiredgrantStatusstringrequiredAvailable options: PENDING, REJECTED, ACCEPTED, COMPLETED, TERMINATED, PAUSED, MARKED_FOR_FUTURE_TERMINATION
tokenTypestring | nullrequiredvestingsobject[]requiredShow child attributes
vestingIDstringrequiredvestingDatestringrequiredstatusstringrequiredAvailable options: PENDING, VESTED, FORFEITED, EXPIRED, CANCELLED, OFF_PLATFORM, UNLOCKED, SETTLED
vestedUnitsstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
sequenceinteger | nullrequiredprojectedVestedUnitsstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
projectedUnvestedUnitsstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$
totalVestedUnitsstringrequiredAllowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$