Skip to main content
Offboarding moves a worker from Active to Former status on a scheduled exit date. Use it when an employee resigns, a contract ends, or you need to remove someone from your active workforce. Cadana handles the status transition automatically on the exit date — you just schedule it.

​
Schedule Offboarding

To schedule a worker for offboarding, provide an exit date and reason. You can optionally adjust their compensation for the exit period.

​
Request Fields

If you set includeInRegularPayroll to true, the exit date must fall after the business’s payroll cutoff day for the current period. Otherwise, the person may not be included in the expected payroll run. The payroll cutoff day is configured in the Dashboard under Settings → Company Profile → Payroll & Tax Info.

​
Cancel Offboarding

Cancel a pending offboarding if the decision is reversed or it was scheduled in error. This returns the person to Active status.
The person must be in Offboarding status. Cancelling offboarding for a person who is already Former or Active returns a 400 error.

​
Reinstate a Worker

To bring a former worker back to active status — for example, a rehire or a reversal — use the reinstate endpoint.
The person must be in Former status. Reinstating a person who is still Active or Offboarding returns a 400 error.

​
Offboarding Lifecycle

The diagram below shows how a person’s status transitions through the offboarding process.
Offboarding completes automatically on the day after the exit date. For example, if the exit date is June 30, the person’s status changes to Former on July 1.

​
Webhook Events

Cadana delivers webhook events for each offboarding lifecycle transition. Subscribe to these via the Webhooks configuration.
To get full offboarding details (compensation, payroll inclusion), query GET /v1/persons/{personId} after receiving the event.
See Events for full payload examples.

​
Notifications

When offboarding is scheduled, Cadana sends an offboarding scheduled email notification to the person, informing them of their exit date.

​
Offboarding Details in GET Response

While a person is in Offboarding status, the GET /v1/persons/{personId} response includes an offboardingDetails object with the scheduled offboarding information.
The offboardingDetails field is only present while the person is in Offboarding status. Once they transition to Former or are cancelled back to Active, this field is no longer included in the response.

​
Next Steps

Payroll Lifecycle

Understand payroll status transitions and webhook events

Pay Workers via Payroll

Run payroll for your active workers