Skip to main content
POST
Refresh 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"

groupId
string
required

Opaque employee group identifier in this company.

Example:

"group-engineering"

Response

Refreshed or archived group.

Refreshed group details, or archived:true and group:null when its linked source is unavailable.

archived
enum<boolean>
required

True when sync archived the group instead of returning refreshed details.

Available options:
false
Example:

false

group
Group · object
required

Refreshed group details, or null when the linked source caused the group to be archived.

Example: