Document templates & integrations

Sync Greenhouse Candidates

Fetches hired candidates from Greenhouse Harvest and caches them encrypted on the credential.

POSThttps://api.toku.com/hris/sync-greenhouse-candidates

Not available to API keys yet. It will need integrations:write.

curl --request POST \
  --url 'https://api.toku.com/hris/sync-greenhouse-candidates' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "candidates": [
    {
      "candidateId": "string",
      "applicationId": "string",
      "jobId": "string",
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "email": "string",
      "jobTitle": "string",
      "department": "string",
      "location": "string",
      "startDate": "string",
      "hiredAt": "string",
      "imported": true,
      "eligible": true,
      "ineligibleReason": "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.

Response

200Successful response
candidatesobject[]required
Show child attributes
candidateIdstringrequired
applicationIdstring | nullrequired
jobIdstring | nullrequired
firstNamestringrequired
lastNamestringrequired
fullNamestringrequired
emailstring | nullrequired
jobTitlestring | nullrequired
departmentstring | nullrequired
locationstring | nullrequired
startDatestring | nullrequired
hiredAtstring | nullrequired
importedbooleanrequired
eligiblebooleanrequired
ineligibleReasonstring | nullrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits