API Reference
Log In
API Reference

Sync viewEmploymentProfile and Partner resources for a given worker

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

company unique identifier

uuid
required

worker unique identifier

Body Params
boolean

Whether to sync related Workbright collections

boolean

Whether to sync cases from Onboard assigned tasks

boolean

Whether to sync document assignments in the I9 case

boolean

Whether to pin this worker I-9/W-4 forms to the Workbright submission each case actually produced, resolved from the submission history rather than the assignment shared current pointer. Repairs forms that submitted before lockedSubmissionId existed. Refreshes submission history from Workbright when there is work to do. Defaults to false.

boolean

Whether to repair this worker's Workbright references before syncing. It runs both directions. It restores a missing workbrightRefs.employeeId on the workerCase, resolved from a sibling workerCase, the profile employeeIds index, or a Workbright lookup by personal email; a workerCase without that id makes no Workbright call and joins no mirror, so its I-9 stays frozen on the step it was at. It also adds to the profile's root employeeIds any subdomain/employeeId pair a non-disabled workerCase already carries, because webhook routing and the document-assignment sync find a profile only through that index. Disabled workerCases are left alone, a profile that is already consistent costs nothing, and no failure of the repair fails the sync. Defaults to true.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json