Skip to main content
GET
List employees in a 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"

Query Parameters

query
string

Employee-name search using the same matching as the group member list.

Example:

"Avery"

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,
email,
jobTitle,
id
Example:

"name"

sortDirection
enum<string>
default:asc

Ascending or descending order. Defaults to asc.

Available options:
asc,
desc
Example:

"asc"

Response

List group members.

Current non-archived roster page and optional matching count.

members
Group employee · object[]
required

Matching non-archived employees in the group. They need not have workspace membership.

Example:
pagination
Group pagination · object
required

Page position and optional total count.

Example: