Skip to main content
POST
Count matching employees

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
filter
Employee filter · object

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

Example:

Response

Total number of matching employees, including zero when none match.

The matching item count; the route determines whether items are employees, job titles, or levels.

total
integer
required

Total matching items, independent of pagination. The route determines the item type.

Required range: x >= 0
Example:

1