curl --request POST \
--url https://api.gowindmill.com/api/v2/c/{companyId}/employees/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"status": "CURRENT",
"query": "Avery"
},
"page": 1,
"pageSize": 20,
"include": {
"total": true
}
}
'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/employees/search"
payload = {
"filter": {
"status": "CURRENT",
"query": "Avery"
},
"page": 1,
"pageSize": 20,
"include": { "total": True }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {status: 'CURRENT', query: 'Avery'},
page: 1,
pageSize: 20,
include: {total: true}
})
};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/employees/search', 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}/employees/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'status' => 'CURRENT',
'query' => 'Avery'
],
'page' => 1,
'pageSize' => 20,
'include' => [
'total' => true
]
]),
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}/employees/search"
payload := strings.NewReader("{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gowindmill.com/api/v2/c/{companyId}/employees/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/employees/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"employees": [
{
"id": "employee-avery",
"name": "Avery Chen",
"avatarUrl": null,
"jobTitle": "Engineer",
"managerId": "employee-morgan",
"primaryEmail": "avery@example.test",
"phoneNumber": null,
"firstName": "Avery",
"preferredName": null,
"lastName": "Chen",
"isActiveMember": true
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"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": "RATE_LIMITED",
"message": "<string>",
"requestId": "<string>"
}
}Search employee profiles
Returns a page of employee names, contact details, job titles, manager IDs, and workspace membership details. For an individual employee’s employment details and all known email addresses, use GET /c//employees/. Current employees are selected by default. Pages start at 1; pageSize defaults to 20 and is limited to 100. Set include.total to true to request a count; otherwise pagination.total is omitted. Without sort, a top-level filter.query uses relevance descending and other searches use name ascending.
curl --request POST \
--url https://api.gowindmill.com/api/v2/c/{companyId}/employees/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"status": "CURRENT",
"query": "Avery"
},
"page": 1,
"pageSize": 20,
"include": {
"total": true
}
}
'import requests
url = "https://api.gowindmill.com/api/v2/c/{companyId}/employees/search"
payload = {
"filter": {
"status": "CURRENT",
"query": "Avery"
},
"page": 1,
"pageSize": 20,
"include": { "total": True }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {status: 'CURRENT', query: 'Avery'},
page: 1,
pageSize: 20,
include: {total: true}
})
};
fetch('https://api.gowindmill.com/api/v2/c/{companyId}/employees/search', 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}/employees/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'status' => 'CURRENT',
'query' => 'Avery'
],
'page' => 1,
'pageSize' => 20,
'include' => [
'total' => true
]
]),
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}/employees/search"
payload := strings.NewReader("{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gowindmill.com/api/v2/c/{companyId}/employees/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gowindmill.com/api/v2/c/{companyId}/employees/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"status\": \"CURRENT\",\n \"query\": \"Avery\"\n },\n \"page\": 1,\n \"pageSize\": 20,\n \"include\": {\n \"total\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"employees": [
{
"id": "employee-avery",
"name": "Avery Chen",
"avatarUrl": null,
"jobTitle": "Engineer",
"managerId": "employee-morgan",
"primaryEmail": "avery@example.test",
"phoneNumber": null,
"firstName": "Avery",
"preferredName": null,
"lastName": "Chen",
"isActiveMember": true
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"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": "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
Response
Employee profiles and pagination. Total is present only when requested.
Was this page helpful?