Offboard a user
Runs the full offboarding process (offboarding notice + revocations) for the user. Omit scheduled_at to offboard immediately; provide a future timestamp to schedule it. Calling again with a new scheduled_at reschedules an existing planned offboarding. A user already being offboarded or already offboarded returns a validation error.
Authorizations
Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.
Headers
Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.
1 - 255Path Parameters
User ID
Body
Offboard parameters
Request body for offboarding a user. Omit scheduled_at to offboard immediately; provide a future timestamp to schedule it. Calling again with a new value reschedules an existing planned offboarding.
When to offboard. Omitted or null offboards now; a future ISO 8601 timestamp schedules it.
Response
User offboarded or scheduled
A user in the organization
Email address
First name
User ID
Last name
Current status
active, inactive, onboarding, onboarding_provisioning_planned, offboarding, offboarding_planned, offboarded Deactivation timestamp
Departments the user belongs to
Employment type
full_time, part_time, contract, freelance, internship, apprenticeship, working_student, training Full name (computed)
Creation timestamp
Job title
City location
Manager user ID
Teams the user belongs to
Last update timestamp

