Benefits & tax profiles
Get Kota Connection Status
Reports Kota platform connection status from stored credentials, returning NOT_CONNECTED when none exist.
GEThttps://api.toku.com/hris/get-kota-connection-status
Required scope: integrations:read
curl --request GET \
--url 'https://api.toku.com/hris/get-kota-connection-status' \
--header 'Authorization: Bearer <token>'200 response
{
"connected": true,
"status": "NOT_CONNECTED",
"externalEmployerID": "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.
Response
200Successful response
connectedbooleanrequiredstatusstringrequiredAvailable options: NOT_CONNECTED, CONNECTED, NEEDS_ATTENTION, DISCONNECTED
externalEmployerIDstring400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits