Skip to main content
GET
List readable employee groups

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"

Query Parameters

query
string

Optional search text. Group and category names use a case-insensitive substring match.

Example:

"Engineering"

type
enum<string>

MANUAL has an explicit roster; FILTER uses employee rules; SYNCED follows an integration group; SCIM is provisioned.

Available options:
MANUAL,
FILTER,
SYNCED,
SCIM
Example:

"MANUAL"

categoryId
string<uuid>[]

One or more category UUIDs. Matching any selected category is sufficient.

Example:
includeUncategorized
string

Include groups with no active categories, combined with categoryId by OR.

Example:

"true"

externalType
string[]

Integration-defined group type. The group list accepts a single value or repeated values.

source
enum<string>

windmill selects MANUAL/FILTER groups; scim selects SCIM; integration selects SYNCED groups.

Available options:
windmill,
scim,
integration
Example:

"windmill"

integrationId
string

Owning integration identifier, or null for groups without an integration link.

visibility
enum<string>

company selects company-wide or global read access; restricted selects other readable groups.

Available options:
company,
restricted
Example:

"company"

createdByEmployeeId
string

Employee who created this resource, or null when no employee creator is recorded.

memberCountOperator
enum<string>

Comparison applied to memberCount. Supply both fields together.

Available options:
lt,
lte,
eq,
gt,
gte
Example:

"gte"

memberCount
integer | null

Nonnegative member count threshold. Supply memberCountOperator with this value.

Required range: x >= 0
Example:

1

page
integer
default:1

One-based page number. Defaults to 1.

Required range: 1 <= x <= 90071992547409
Example:

1

pageSize
integer
default:50

Maximum results per page, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
Example:

50

include
Additional response details · object

Request total:true to include pagination.total; otherwise no count is performed.

Example:
sortProperty
enum<string>
default:name

Field used to order results. Supported values depend on this listing. Defaults to name.

Available options:
name,
employeeCount,
externalType,
createdAt,
updatedAt
Example:

"name"

sortDirection
enum<string>
default:asc

Ascending or descending order. Defaults to asc.

Available options:
asc,
desc
Example:

"asc"

Response

List employee groups.

Readable group page, continuation flag, and optional matching count.

groups
Employee group · object[]
required

Matching groups in the requested page, or an empty array.

Example:
pagination
Group pagination · object
required

Page position and optional total count.

Example: