curl --request GET \
--url https://api.gowindmill.com/api/v2/c/{companyId}/groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gowindmill.com/api/v2/c/{companyId}/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gowindmill.com/api/v2/c/{companyId}/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gowindmill.com/api/v2/c/{companyId}/groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"id": "group-engineering",
"name": "Engineering",
"type": "MANUAL",
"categoryIds": [
"11111111-1111-4111-8111-111111111111"
],
"employeeCount": 1,
"integrationId": null,
"integrationUserGroupId": null,
"integrationUserGroupExternalType": null,
"createdByEmployeeId": "employee-avery",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z",
"sharingAccess": {
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
},
"canWrite": true
}
],
"pagination": {
"page": 1,
"pageSize": 50,
"hasMore": false,
"total": 1
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"requestId": "<string>"
}
}List readable employee groups
Lists non-archived employee groups that you can read. Filter by name, type, source, category, sharing, creator, integration, external group type, or employee count. categoryId and externalType accept one value or repeated query parameters. A group can match any selected category; includeUncategorized also includes groups without an active category. All other supplied filters must match. Pages start at 1; pageSize defaults to 50 and is limited to 100. Request include.total for the matching count; otherwise the count is omitted. Continue while pagination.hasMore is true. Groups are sorted by name ascending, then ID, unless another sort is requested.
curl --request GET \
--url https://api.gowindmill.com/api/v2/c/{companyId}/groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gowindmill.com/api/v2/c/{companyId}/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gowindmill.com/api/v2/c/{companyId}/groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gowindmill.com/api/v2/c/{companyId}/groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"id": "group-engineering",
"name": "Engineering",
"type": "MANUAL",
"categoryIds": [
"11111111-1111-4111-8111-111111111111"
],
"employeeCount": 1,
"integrationId": null,
"integrationUserGroupId": null,
"integrationUserGroupExternalType": null,
"createdByEmployeeId": "employee-avery",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z",
"sharingAccess": {
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
},
"canWrite": true
}
],
"pagination": {
"page": 1,
"pageSize": 50,
"hasMore": false,
"total": 1
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"requestId": "<string>"
}
}Authorizations
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.
Authorization: Bearer wm_api_example
OAuth access tokens are issued for connected Windmill applications.
Authorization: Bearer <OAUTH_ACCESS_TOKEN>
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
Query Parameters
Response
List employee groups.
Readable group page, continuation flag, and optional matching count.
Was this page helpful?