/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Changes
Docs
Sign in
Docs
History
Schema
Filter operations
agent_workers
5
ai
9
ai_evals
14
amqp_trigger
8
app
43
asset
10
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
7
email_trigger
8
favorite
2
flow
21
flow_conversations
4
folder
11
gcp_trigger
14
Git Sync
13
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
20
indexSearch
7
input
6
integration
2
job
104
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
14
nats_trigger
8
npm_proxy
6
oauth
13
oidc
2
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
31
schedule
10
script
37
service_logs
2
setting
63
settings
4
sqs_trigger
8
teams
1
token
1
trash
5
trigger
3
user
65
post
/auth/login
login with password
post
/auth/logout
logout
get
/auth/is_smtp_configured
check if SMTP is configured for password reset
get
/auth/is_password_login_disabled
check if password login is disabled instance-wide
post
/auth/request_password_reset
request password reset email
get
/auth/login_link/{token}
consume a single-use login link, set the session cookie and redirect
post
/auth/reset_password
reset password using token
get
/w/{workspace}/users/get/{username}
get user (require admin privilege)
post
/w/{workspace}/users/update/{username}
update user (require admin privilege)
get
/w/{workspace}/users/is_owner/{path}
is owner of path
post
/users/setpassword
set password
post
/users/set_password_of/{user}
set password for a specific user (require super admin)
post
/users/set_login_type/{user}
set login type for a specific user (require super admin)
post
/users/create
create user
post
/users/update/{email}
global update user (require super admin)
get
/users/username_info/{email}
global username info (require super admin)
post
/users/rename/{email}
global rename user (require super admin)
post
/users/change_email/{email}
global change user email (require super admin)
delete
/users/delete/{email}
global delete user (require super admin)
post
/users/overwrite
global overwrite users (require super admin and EE)
get
/users/export
global export users (require super admin and EE)
get
/users/ext_jwt_tokens
list external JWT tokens (ee only)
get
/users/guests
list the distinct guests of the trailing window (superadmin only)
post
/users/onboarding
Submit user onboarding data
delete
/w/{workspace}/users/delete/{username}
delete user (require admin privilege, except for the creator of a fork removing a non-admin member of the fork)
get
/w/{workspace}/users/offboard_preview/{username}
preview offboarding for a workspace user (require admin privilege)
post
/w/{workspace}/users/offboard/{username}
offboard a workspace user (reassign objects, optionally delete user)
get
/users/offboard_preview/{email}
preview global offboarding for a user across all workspaces (require super admin)
post
/users/offboard/{email}
offboard a user globally (reassign objects across workspaces, optionally delete)
post
/w/{workspace}/users/convert_to_group/{username}
convert manual user to group user (require admin privilege)
get
/users/email
get current user email (if logged in)
get
/users/refresh_token
refresh the current token
get
/users/tutorial_progress
get tutorial progress
post
/users/tutorial_progress
update tutorial progress
post
/users/leave_instance
leave instance
get
/users/usage
get current usage outside of premium workspaces
get
/users/all_runnables
get all runnables in every workspace
get
/users/whoami
get current global whoami (if logged in)
get
/users/list_invites
list all workspace invites
get
/w/{workspace}/users/whoami
whoami
post
/users/accept_invite
accept invite to workspace
post
/users/decline_invite
decline invite to workspace
post
/w/{workspace}/users/impersonate_service_account
impersonate a service account
post
/w/{workspace}/users/exit_impersonation
exit service account impersonation
get
/w/{workspace}/users/whois/{username}
whois
get
/users/exists/{email}
exists email
get
/users/list_as_super_admin
list all users as super admin (require to be super amdin)
get
/w/{workspace}/users/list
list users
get
/w/{workspace}/users/list_addable
list instance users that can still be added to this workspace (require to be super admin)
get
/w/{workspace}/users/list_usage
list users usage
get
/w/{workspace}/users/list_usernames
list usernames
get
/w/{workspace}/users/username_to_email/{username}
get email from username
post
/users/tokens/create
create token
post
/users/tokens/impersonate
create token to impersonate a user (require superadmin)
post
/users/login_links
mint a single-use login link for an account (require superadmin)
get
/users/cloud_trial_offer
whether the signed-in account holds an unconsumed pre-approved self-hosted trial offer (cloud only)
post
/users/cloud_trial_offer
record or consume a pre-approved self-hosted trial offer for a cloud account (require superadmin, cloud only)
post
/users/cloud_trial_offer/go
start the signed-in account's pre-approved self-hosted trial on the customer portal (cloud only). A POST answered as JSON rather than a redirecting GET, so a cross-site navigation cannot start it; the browser navigates to `location` itself
get
/users/onboarding_profile
the invite context recorded for the signed-in account, if any (cloud only)
post
/users/onboarding_profile
record the invite context an account's onboarding tailors itself from (require superadmin, cloud only)
delete
/users/tokens/delete/{token_prefix}
delete token
post
/users/tokens/update_scopes/{token_prefix}
update scopes of an existing token (owner only)
post
/users/tokens/update_label/{token_prefix}
update label of an existing token (owner only)
get
/users/tokens/list
list token
post
/oauth/login_callback/{client_name}
login with oauth authorization flow
variable
10
volume
4
websocket_trigger
8
worker
13
workspace
142
workspace_dependencies
5
workspace_integration
8
user
Copy Markdown
Copied
Copy failed
Changes to list instance users that can still be added to this workspace (require to be super admin)
get
/w/{workspace}/users/list_addable
Aug 4, 2026
abb809f7f36e
Revision changes
info
endpoint added