Grants, vesting & distributions
Get Grant Configuration By ID
Returns one grant configuration with signing tabs and a presigned exercise-form download URL.
GEThttps://api.toku.com/tga/get-grant-configuration-by-id
Not available to API keys yet. It will need grants:read.
curl --request GET \
--url 'https://api.toku.com/tga/get-grant-configuration-by-id?grantConfigurationID=%3CgrantConfigurationID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"grantConfigurationID": "string",
"name": "string",
"kind": "RTU",
"isExercisable": true,
"useStrike": true,
"hasDiscountFMV": true,
"redemptionHold": 0,
"redemptionCap": 0,
"redemptionLiftPeriod": 0,
"exerciseLockupMonths": 0,
"optionExpiryYears": 0,
"optionExerciseWindowDays": 0,
"exercisedOptionsPastTenseLabel": "string",
"exercisedOptionsPresentTenseLabel": "string",
"exercisedOptionActionLabel": "string",
"exercisedOptionPotentialActionLabel": "string",
"cashRedemptionMethod": true,
"unitsRedemptionMethod": true,
"coinMarketCapID": "string",
"showLtipRedemptionProcessingAlert": true,
"signingTabs": {
"prefilledTextTabs": [
{
"type": "fullLegalName",
"pageNumber": "string",
"xPosition": "string",
"yPosition": "string"
}
],
"bankTabs": [
{
"label": "string",
"pageNumber": "string",
"xPosition": "string",
"yPosition": "string"
}
],
"signerTabs": [
{
"type": "signature",
"pageNumber": "string",
"xPosition": "string",
"yPosition": "string",
"isRecipient": true,
"name": "string",
"email": "string"
}
]
},
"exerciseFormDownloadUrl": "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
grantConfigurationIDstring<uuid>requiredResponse
200Successful response
grantConfigurationIDstringrequirednamestringrequiredkindstringrequiredAvailable options: RTU, RTA, TOKEN_BONUS, TPA, OPTION, WARRANT, LTIP, TSA, FTIA, PHANTOMUNITS, FOUNDERROUND, FTI, TOKENSUB, PERFORMANCE
isExercisablebooleanrequireduseStrikebooleanhasDiscountFMVbooleanredemptionHoldnumberredemptionCapnumberredemptionLiftPeriodnumberexerciseLockupMonthsnumber | nulloptionExpiryYearsnumber | nulloptionExerciseWindowDaysnumber | nullexercisedOptionsPastTenseLabelstringexercisedOptionsPresentTenseLabelstringexercisedOptionActionLabelstringexercisedOptionPotentialActionLabelstringcashRedemptionMethodbooleanunitsRedemptionMethodbooleancoinMarketCapIDstringshowLtipRedemptionProcessingAlertbooleansigningTabsobject | nullShow child attributes
prefilledTextTabsobject[]requiredShow child attributes
typestringrequiredAvailable options: fullLegalName, exerciseDate, grantDate, numberOfUnitsToRedeem, redemptionMethod
pageNumberstringrequiredxPositionstringrequiredyPositionstringrequiredbankTabsobject[]requiredShow child attributes
labelstringrequiredpageNumberstringrequiredxPositionstringrequiredyPositionstringrequiredsignerTabsobject[]requiredShow child attributes
typestringAvailable options: signature, initial, dateSigned
pageNumberstringrequiredxPositionstringrequiredyPositionstringrequiredisRecipientbooleanrequirednamestringrequiredemailstringrequiredexerciseFormDownloadUrlstring400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits