Skip to main content
POST
Offboard a user

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.

Headers

Idempotency-Key
string

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.

Required string length: 1 - 255

Path Parameters

user_id
string<uuid>
required

User ID

Body

application/json

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.

scheduled_at
string<date-time> | null

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
string<email>
required

Email address

first_name
string
required

First name

id
string<uuid>
required

User ID

last_name
string
required

Last name

status
enum<string>
required

Current status

Available options:
active,
inactive,
onboarding,
onboarding_provisioning_planned,
offboarding,
offboarding_planned,
offboarded
deactivated_at
string<date-time> | null

Deactivation timestamp

departments
string[]

Departments the user belongs to

employment_type
enum<string> | null

Employment type

Available options:
full_time,
part_time,
contract,
freelance,
internship,
apprenticeship,
working_student,
training
full_name
string

Full name (computed)

inserted_at
string<date-time>

Creation timestamp

job_title
string | null

Job title

location_city
string | null

City location

manager_user_id
string<uuid> | null

Manager user ID

teams
string[]

Teams the user belongs to

updated_at
string<date-time>

Last update timestamp

Last modified on September 29, 2026