/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 39m ago · Updated 5h ago
View markdown
windmill
Windmill API
get
global username info (require super admin)
latest
OpenAPI 3.0.3
Apache 2.0
raw.githubusercontent.com
2026-08-15
826
354
1004.1 KB
a7f071808448
agent_workers
5
amqp_trigger
8
app
41
asset
9
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
5
email_trigger
8
favorite
2
flow
20
flow_conversations
3
folder
11
gcp_trigger
11
Git Sync
10
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
17
indexSearch
7
input
6
integration
1
job
98
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
13
nats_trigger
8
npm_proxy
6
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
28
schedule
10
script
36
service_logs
2
setting
52
settings
4
sqs_trigger
8
teams
1
token
1
trigger
3
user
57
post
login with password
post
logout
get
check if SMTP is configured for password reset
get
check if password login is disabled instance-wide
post
request password reset email
post
reset password using token
get
get user (require admin privilege)
post
update user (require admin privilege)
get
is owner of path
post
set password
post
set password for a specific user (require super admin)
post
set login type for a specific user (require super admin)
post
create user
post
global update user (require super admin)
get
global username info (require super admin)
post
global rename user (require super admin)
post
global change user email (require super admin)
delete
global delete user (require super admin)
post
global overwrite users (require super admin and EE)
get
global export users (require super admin and EE)
get
list external JWT tokens (ee only)
post
Submit user onboarding data
delete
delete user (require admin privilege, except for the creator of a fork removing a non-admin member of the fork)
get
preview offboarding for a workspace user (require admin privilege)
post
offboard a workspace user (reassign objects, optionally delete user)
get
preview global offboarding for a user across all workspaces (require super admin)
post
offboard a user globally (reassign objects across workspaces, optionally delete)
post
convert manual user to group user (require admin privilege)
get
get current user email (if logged in)
get
refresh the current token
get
get tutorial progress
post
update tutorial progress
post
leave instance
get
get current usage outside of premium workspaces
get
get all runnables in every workspace
get
get current global whoami (if logged in)
get
list all workspace invites
get
whoami
post
accept invite to workspace
post
decline invite to workspace
post
impersonate a service account
post
exit service account impersonation
get
whois
get
exists email
get
list all users as super admin (require to be super amdin)
get
list users
get
list instance users that can still be added to this workspace (require to be super admin)
get
list users usage
get
list usernames
get
get email from username
post
create token
post
create token to impersonate a user (require superadmin)
delete
delete token
post
update scopes of an existing token (owner only)
post
update label of an existing token (owner only)
get
list token
post
login with oauth authorization flow
variable
10
volume
4
websocket_trigger
8
worker
10
workspace
128
workspace_dependencies
5
workspace_integration
8
user
global username info (require super admin)
get
/users/username_info/{email}
Path parameters
email
string
required
Response
user renamed
object
required
username
string
required
workspace_usernames
object[]
required