Contract templates
Get Contractor Template Review
Reads the account-scoped contractor agreement redline review and its pending suggestions.
GEThttps://api.toku.com/hris/get-contractor-template-review
Required scope: documents:read
curl --request GET \
--url 'https://api.toku.com/hris/get-contractor-template-review?orgId=%3CorgId%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"canReview": true,
"orgName": "string",
"templates": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"activeName": "string",
"kind": "CONTRACTOR",
"reviewKey": "string",
"countryCodes": [
"string"
],
"reviewStatus": "string",
"reviewRevision": 0,
"customized": true,
"version": 0,
"available": true,
"updatedAt": "2026-01-01T00:00:00Z"
}
],
"review": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewKey": "string",
"revision": 0,
"status": "string",
"events": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"revision": 0,
"action": "string",
"createdAt": "2026-01-01T00:00:00Z",
"notificationPending": 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.
Query parameters
orgIdstring<uuid>requiredreviewKeystring"contractor" (the default) or "employment:<template id>".
Allowed: matches ^(contractor|employment:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
Response
200Successful response
canReviewbooleanorgNamestringtemplatesobject[]Show child attributes
idstring<uuid>namestringactiveNamestringkindstringCONTRACTOR templates share one review; each EMPLOYMENT (EOR) template has its own.
Available options: CONTRACTOR, EMPLOYMENT
reviewKeystringcountryCodesstring[]reviewStatusstring | nullreviewRevisionintegercustomizedbooleanversioninteger | nullavailablebooleanupdatedAtstring<date-time>reviewobject | nullShow child attributes
idstring<uuid>reviewKeystringrevisionintegerstatusstringdataanyeventsobject[]Show child attributes
idstring<uuid>revisionintegeractionstringcreatedAtstring<date-time>dataanynotificationPendingboolean400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits