Identity, people & notifications
Preview Employees Sync
Fetches employees from the org employee-integration source (ADP/Workday/Deel/UKG/BambooHR) with filters applied, no writes.
POSThttps://api.toku.com/stablecoin-payroll/preview-employees-sync
Not available to API keys.
curl --request POST \
--url 'https://api.toku.com/stablecoin-payroll/preview-employees-sync' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"orgID": "string",
"filters": {}
}'200 response
{
"success": true,
"totalRecords": 0,
"filteredRecords": 0,
"employees": [
{
"email": "string",
"givenName": "string",
"familyName": "string",
"externalEmployeeID": "string",
"positionID": "string",
"country": "string",
"employmentType": "string",
"subEmploymentType": "string",
"remarks": "string",
"payrollEntity": "string",
"payrollGroup": "string",
"baseSalary": "string",
"baseSalaryCurrency": "string",
"department": "string",
"address": "string",
"payrollFileNumber": "string",
"isTerminated": true,
"isActive": 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
orgIDstringfiltersobject | objectNOTE(ck): a recursive z.lazy() schema has no contract form; TGA still checks it
Show child attributes
versionanyrequiredrootGroupanyrequiredResponse
200Successful response
successbooleanrequiredtotalRecordsnumberrequiredfilteredRecordsnumberrequiredemployeesobject[]requiredShow child attributes
emailstring | nullgivenNamestring | nullfamilyNamestring | nullexternalEmployeeIDstring | nullpositionIDstring | nullcountrystring | nullemploymentTypestring | nullsubEmploymentTypestring | nullremarksstring | nullpayrollEntitystring | nullpayrollGroupstring | nullbaseSalarystring | numberbaseSalaryCurrencystring | nulldepartmentstring | nulladdressstring | nullpayrollFileNumberstring | nullisTerminatedboolean | nullisActiveboolean | null400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits