Skip to main content
POST
Create an employee

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"

Body

application/json
primaryEmail
string<email>
required

Valid email address for the new employee. Any existing current or former employee match returns 409. Takes precedence over the deprecated email alias.

Maximum string length: 320
Example:

"avery@example.test"

firstName
string
required

Required first name, from 1 to 200 characters.

Required string length: 1 - 200
Example:

"Avery"

lastName
string
required

Required last name, from 1 to 200 characters.

Required string length: 1 - 200
Example:

"Chen"

email
string<email>
deprecated

Deprecated alias for primaryEmail. Supply primaryEmail for new integrations.

Maximum string length: 320
jobTitle
string | null

Job title for the new employee, up to 256 characters. Optional and nullable.

Maximum string length: 256
Example:

"Engineer"

managerId
string | null

A current employee in the same company. Omit or send null for no manager.

Required string length: 1 - 128
Example:

"employee-morgan"

Response

New employee profile.

employee
Employee · object
required

Employee profile returned by this operation.

Example: