Search documentation

Search the Fumadocs-backed documentation index.

ax org

List, switch, and invite to organizations.

CommandUse
org listList orgs available to your credentials.
org viewShow the active org and your role.
org switchSet the active org.
org inviteInvite people as non-admin members.

Requires credentials from ax auth login (or AX_API_KEY).

org list

List orgs available to the current credentials; * marks the active org.

ax org list [--json]

org view

Show the active org, your role, and the platform URL.

ax org view [--json]

org switch

Set the active org for subsequent CLI commands.

ax org switch <ORG_ID>
Argument / flagWhat it does
<ORG_ID>Required. Org id from ax org list.

Most platform commands also take a one-off --org <org-id> override that does not change the saved active org.

org invite

Invite people to the org as members (never admins; role promotion stays in org Settings). Org admin required. Invite emails must use a domain that is already verified on the org.

ax org invite <EMAIL>...
Argument / flagWhat it does
<EMAIL>...One or more addresses. Required when piped; a TTY prompts if omitted.
--org <org-id>Invite into another org without changing the active one.

Examples:

# Invite two teammates to the active org
ax org invite dana@acme.com lee@acme.com

# Invite into another org without switching to it
ax org invite dana@acme.com --org 01KSDQ...

Domain checks run for the whole batch before any invite is created. Clerk writes are sequential and not transactional: if a later email fails after earlier ones succeeded, the error names who was already invited (pending) and who failed (no rollback).

Domains: only emails whose domain is already registered and verified on the org are eligible.

  • Verified registered domain → invite proceeds.
  • No verified domains (empty list or only unverified) → no invite; add or verify a domain in org Settings, then retry.
  • Unverified registered domain → no invite until that domain is verified.
  • Unregistered domain → no invite; register and verify it in Settings (the CLI does not auto-register domains).