Skip to main content
POST
Add employees to a manual 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"

groupId
string
required

Opaque employee group identifier in this company.

Example:

"group-engineering"

Body

application/json

Select employee IDs or all employees matching the API filter. expectedCount counts selected employees, including existing group members, rather than new memberships.

selection
Employee selection · object
required

Employees selected for the operation.

Example:
expectedCount
integer
required

Must equal the number of employees resolved by the selection before the operation. A mismatch rejects the request.

Required range: x >= 0
Example:

1

Response

Add group members.

Confirmation that the command completed.

success
boolean
required

True when the command completed successfully.

Example:

true