Skip to main content
GET
List stat views

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"

Query Parameters

Case-insensitive text matched against view names. Omit for all readable views.

Maximum string length: 120
Example:

"Engineering"

page
integer
default:1

One-based page number. Defaults to 1.

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

1

pageSize
integer
default:20

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

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

20

include
Additional response details · object

Additional listing details to calculate. Omit to skip the count.

Example:

Response

Accessible stat views in deterministic name order

views
Stat view summary · object[]
required

Readable active views ordered by case-insensitive name, then view ID.

pagination
Pagination · object
required

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