Org settings, dashboards & reporting
Termination Audit Report
Delegates to TerminationAuditService to list termination audit rows filtered by date range and role.
POSThttps://api.toku.com/platform/termination-audit-report
Not available to API keys.
curl --request POST \
--url 'https://api.toku.com/platform/termination-audit-report' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"dateFrom": "2026-01-01T00:00:00Z",
"dateTo": "2026-01-01T00:00:00Z",
"roleInOrgID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"includeScheduled": true
}'200 response
[
{
"grantID": "string",
"grantName": "string",
"grantType": "string",
"grantKind": "string",
"recipientName": "string",
"recipientExternalID": "string",
"roleInOrgID": "string",
"employmentType": "string",
"country": "string",
"originalGrantAmount": "string",
"originalGrantAmountFiat": "string",
"finalVestedTokens": "string",
"finalVestedFiat": "string",
"cancelledTokens": "string",
"cancelledFiat": "string",
"settledTokens": "string",
"terminationDate": "string",
"futureTerminationDate": "string",
"grantStatus": "string",
"grantCreatedAt": "string",
"totalVestingPeriods": 0,
"completedVestingPeriods": 0,
"cancelledVestingPeriods": 0,
"terminationHistory": [
{
"terminationInfoID": "string",
"terminationDate": "string",
"terminationStatus": "string",
"isVestingAcceleration": true,
"accelerationDetails": "string",
"createdAt": "string"
}
],
"activityHistory": [
{
"eventType": "string",
"eventDescription": "string",
"createdAt": "string",
"actorName": "string"
}
],
"tags": [
"string"
],
"pricePerUnit": "string",
"currency": "string",
"isCashCompensation": true
}
]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.
Body
application/json
dateFromstring<date-time>dateTostring<date-time>roleInOrgIDstring<uuid>includeScheduledbooleanResponse
200Successful response
grantIDstringrequiredgrantNamestringrequiredgrantTypestringrequiredgrantKindstringrequiredrecipientNamestringrequiredrecipientExternalIDstringrequiredroleInOrgIDstringrequiredemploymentTypestring | nullrequiredcountrystring | nullrequiredoriginalGrantAmountstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
originalGrantAmountFiatstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
finalVestedTokensstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
finalVestedFiatstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
cancelledTokensstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
cancelledFiatstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
settledTokensstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
terminationDatestringrequiredfutureTerminationDatestring | nullrequiredgrantStatusstringrequiredgrantCreatedAtstringrequiredtotalVestingPeriodsintegerrequiredAllowed: at least 0
completedVestingPeriodsintegerrequiredAllowed: at least 0
cancelledVestingPeriodsintegerrequiredAllowed: at least 0
terminationHistoryobject[]requiredShow child attributes
terminationInfoIDstringrequiredterminationDatestringrequiredterminationStatusstringrequiredisVestingAccelerationbooleanrequiredaccelerationDetailsstring | nullrequiredcreatedAtstringrequiredactivityHistoryobject[]requiredShow child attributes
eventTypestringrequiredeventDescriptionstringrequiredcreatedAtstringrequiredactorNamestringrequiredtagsstring[]requiredpricePerUnitstring<decimal>requiredAllowed: matches ^-?[0-9]+(\.[0-9]+)?$
currencystring | nullrequiredisCashCompensationbooleanrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits