WorkOS

Discover the WorkOS operations available through the query and mutate tools. Without arguments, returns the full index of operation names — call it once and reuse the result. Pass filter to narrow the index by keyword (operation name or description). Pass operation for that operation’s parameters and input types, or type to fully expand a specific input/enum type by name. Call whoami to see available environments and their IDs.

list_operations

Run a mutation against your WorkOS account by name. Mutations change real data in the targeted environment. Call list_operations first to discover available operations and their parameters. Pass environment_id to choose the environment (whoami returns your available environments); when the operation declares an environmentId parameter it is applied automatically, so you don’t pass it twice. Without environment_id, operations that don’t require one run against a sandbox environment. Destructive operations (permanent deletes) and billing changes require a confirmation token — the first call returns the impact plus a single-use "confirmation_token" and does not execute; pass the token back with the same arguments to proceed.

mutate

Run a query against your WorkOS account by name. Call list_operations first to discover available operations and their parameters. Pass environment_id to choose the environment (whoami returns your available environments); when the operation declares an environmentId parameter it is applied automatically, so you don’t pass it twice. Without environment_id, operations that don’t require one run against a sandbox environment.

query

Return the identity, role, and capability posture of the authenticated caller. Includes the team, a description of what the role can and cannot do, and the available environments grouped by project, each with its ID and OAuth client ID. Environment names repeat across projects, so identify an environment by its client ID (match the WORKOS_CLIENT_ID in the app’s config) or by its project, not by name. Use the returned environment IDs as the environment_id argument for query and mutate calls.

whoami