curl --request PUT \
--url https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
}
'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access"
payload = {
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyAccess: 'read',
allManagersAccess: 'none',
employeeAccess: [{employeeId: 'employee-avery', access: 'write'}],
groupAccess: [],
subtreeAccess: []
})
};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access', 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/{groupId}/access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companyAccess' => 'read',
'allManagersAccess' => 'none',
'employeeAccess' => [
[
'employeeId' => 'employee-avery',
'access' => 'write'
]
],
'groupAccess' => [
],
'subtreeAccess' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access"
payload := strings.NewReader("{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"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>"
}
}Replace employee group sharing
Replaces sharing settings for everyone in the company, managers, selected employees, employee groups, and reporting subtrees. All five fields are required, with up to 500 entries per recipient list. An empty list removes that kind of direct sharing. Access supplied by workspace permissions and automations is retained, including edit access for members who can manage groups. Everyone who can edit can also read. Works for every group type and requires existing permission to edit the group. You can remove your own directly granted access.
curl --request PUT \
--url https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
}
'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access"
payload = {
"companyAccess": "read",
"allManagersAccess": "none",
"employeeAccess": [
{
"employeeId": "employee-avery",
"access": "write"
}
],
"groupAccess": [],
"subtreeAccess": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyAccess: 'read',
allManagersAccess: 'none',
employeeAccess: [{employeeId: 'employee-avery', access: 'write'}],
groupAccess: [],
subtreeAccess: []
})
};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access', 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/{groupId}/access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companyAccess' => 'read',
'allManagersAccess' => 'none',
'employeeAccess' => [
[
'employeeId' => 'employee-avery',
'access' => 'write'
]
],
'groupAccess' => [
],
'subtreeAccess' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access"
payload := strings.NewReader("{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/groups/{groupId}/access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyAccess\": \"read\",\n \"allManagersAccess\": \"none\",\n \"employeeAccess\": [\n {\n \"employeeId\": \"employee-avery\",\n \"access\": \"write\"\n }\n ],\n \"groupAccess\": [],\n \"subtreeAccess\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"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
Body
Replace editable sharing grants. System-managed permissions are preserved.
Was this page helpful?