Skip to main content
PUT
Set an employee's employment status

Authorizations

Authorization
string
header
required

Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as Authorization: Bearer <TOKEN>.

Create an API key in your workspace's Settings → API keys. Keys start with wm_api_ and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.

OAuth access tokens are issued for connected Windmill applications.

Both token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.

Path Parameters

companyId
string
required

Company ID. A URL slug is also accepted. The caller must have access to this company.

Required string length: 1 - 128
Example:

"company-acme"

employeeId
string
required

Opaque employee ID in the company. This identifies an org-chart person, not a member or user.

Required string length: 1 - 128
Example:

"employee-avery"

Body

application/json
employmentStatus
enum<string>
required

CURRENT means the employee is not archived; FORMER means archived. Employment status is separate from member access.

Available options:
CURRENT,
FORMER
Example:

"CURRENT"

Response

Employee profile with the requested employment status.

employee
Employee · object
required

Employee profile returned by this operation.

Example: