Skip to main content
POST
Create an employee group

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

Create a MANUAL or FILTER group. Rules are rejected for MANUAL; FILTER defaults to an empty API employee filter.

name
string
required

Group name, trimmed, 1–200 characters. Duplicate group names are permitted.

Required string length: 1 - 200
Example:

"Engineering"

type
enum<string>
required

MANUAL creates an explicit roster; FILTER creates a smart group. SYNCED and SCIM use their own provisioning flows.

Available options:
MANUAL,
FILTER
Example:

"MANUAL"

categoryIds
string<uuid>[]

Up to 100 active category UUIDs. Duplicate IDs are deduplicated. Empty means no categories.

Maximum array length: 100
Example:
rules
Employee rules · object

Employee filter for a FILTER group. Group references are rejected at every depth; relative start dates must be tenure ranges.

Example:

Response

Create an employee group.

Identifier of the newly created group or category.

id
string
required

Identifier of the newly created employee group or category.

Example:

"11111111-1111-4111-8111-111111111111"