Skip to main content
POST
Search employee profiles

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"

Body

application/json
include
Additional response details · object

Set total to true to count all matching results. Omit it to avoid the count query.

Example:
filter
Employee filter · object

Conditions applied to the selection. The API filter defaults employment status to CURRENT.

Example:
sort
Sort order · object

Defaults to relevance descending for a top-level text query, otherwise name ascending.

Example:
page
integer
default:1

One-based page number. Defaults to 1.

Required range: x >= 1
Example:

1

pageSize
integer
default:20

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

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

20

Response

Employee profiles and pagination. Total is present only when requested.

employees
Basic employee profile · object[]
required

Employee profiles returned by this operation. An empty search page contains an empty array.

pagination
Pagination · object
required

Returned page and page size, plus hasMore. Total is omitted unless include.total was requested.