account
#Get account by ID Requires permission: Platform admin, tenant admin, or querying own account
Arguments
- id!
Accounts, authentication (OTP, passkey, password), sessions, roles, and saved locations.
Get account by ID Requires permission: Platform admin, tenant admin, or querying own account
Arguments
Authors for the admin picker.
Arguments
List a tenant's staff accounts (owner + admins) with their config-lock state (platform-admin only). Backs the tenant Staff view where each row has a per-account config-lock toggle.
Arguments
Most recent admin-panel activity per tenant, across each tenant's
owner/admin staff, batched over tenant_ids (platform-admin only).
Powers the "Last activity" column on the tenant list; tenants with no
panel session are omitted from the result.
Arguments
The accounts listAccounts returns for the same input, as a CSV
file: every page at once, up to 5,000 rows. input.pagination is
ignored. truncated says when more matched than the file holds.
Email and phone are masked exactly as the list masks them.
# Authorization
Requires TenantAdmin or PlatformAdmin role. A staff seat needs both
View users and Export data; the owner needs no grant.
Arguments
The caller's saved draft for a form, or null when there is none or it expired. Only ever reads the caller's own drafts.
Arguments
Default
""List saved addresses for a specific account as admin.
Arguments
List all roles for a specific account
Arguments
List accounts for tenant admin panel. Supports filtering by role (customer, driver, vendor, operator), account status, and search term. Results are paginated. # Authorization Requires TenantAdmin or PlatformAdmin role.
Arguments
List sessions with optional filters (admin only). Requires TenantAdmin or PlatformAdmin role.
Arguments
The caller's command-palette history: pinned entries first, then the rest, each most recently used first; at most 70. Only ever reads the caller's own entries.
The caller's preferences for the current console. Never null: a caller who never saved one gets every field null, and the console shows its defaults. Preferences are kept per account and console, so an impersonating platform admin sees their own preferences for that tenant, never the owner's.
The providers connected to the signed-in account.
List all partnerships the current user has access to. Returns partnerships where the user has been granted a role with entity_kind = Partnership. This is used by the client to show a partnership switcher UI.
List the authenticated account's registered passkeys.
The records the caller pinned in the current console, in the caller's order; at most 50. Pins are kept per account, console and role, so an impersonating platform admin sees their own pins for that tenant, never the owner's.
Arguments
Orders the whole list before it is paged. Omitted, most recently active first.
Deprecation reason: Use oauthProviderConfigsWithValues; BET-205
Arguments
List the OAuth app credentials configured for the given owner scope.
Secrets are never returned — each row exposes only has_secret. Platform
scope requires a platform admin; tenant scope is the caller's own tenant.
Arguments
List staff members of a partnership. Returns all accounts that have been granted roles scoped to the specified partnership. Useful for viewing and managing partnership staff. Requires: TenantAdmin, PlatformAdmin, or operating in the partnership context.
Arguments
Get a permission set by ID. Another tenant's set reads as null.
Arguments
List permission sets by context. Uses the tenant from the request context.
Arguments
Arguments
Who signed in to this workspace's console and who tried, newest first. Covers the last 90 days of console sign-ins only; the customer and driver apps are not part of it. The owner's to read: a staff seat is refused whatever its grants.
Arguments
Whether each social sign-in provider is actually usable for the calling
tenant, combining the two settings that have to agree: the tenant's
AuthPolicy (which decides whether apps show the button) and the
tenant's OAuth credentials (which decide whether pressing it works).
Both admin console pages read this so each can warn about the half the
admin isn't currently looking at. Exposes no secret material — only
which credential *fields* are missing.
Every console session of this workspace, across the owner and all staff,
most recently active first. Session.account says whose each one is,
and Session.impersonated marks a support session opened on the
owner's behalf.
The owner's to read: a staff seat is refused whatever its grants.
listSessionsAdmin remains the read for one account's sessions.
Arguments
The signed-in session of this request, or null when anonymous.
Never errors, so a console can call it to learn whether it is signed
in at all.
Change a tenant staff account's email address (platform-admin only).
The new address is applied immediately. markVerified decides whether
it is trusted straight away or marked unverified with a verification
code sent to it. Every session on the account is revoked either way,
because email is a login identifier.
Requires a fresh step-up elevation token — see
adminResetStaffPassword.
Arguments
End the current impersonation session (revoke it). Only meaningful
when called from within an impersonation session; writes a
tenant_impersonation_ended audit row attributed to the platform
admin behind the session.
Start a platform-admin impersonation session for a customer tenant.
Restricted to PlatformAdmin and gated on a fresh step-up token
(X-Elevation), exactly like ownership transfer. On success the
caller receives an act-as token pair scoped to the target tenant's
owner; the platform admin behind it is recorded on the session and in
the act claim, and a tenant_impersonation_started audit row is
written with the supplied reason.
Arguments
Reset an account's password as admin.
If the account has an existing password credential, the hash is updated.
If no password credential exists, one is created.
Requires an admin-tier role. The owner's password is reset only by a
platform admin, and another admin's only by the owner or a platform
admin (FORBIDDEN otherwise).
Arguments
Reset a tenant staff account's password (platform-admin only).
Two modes. SET_PASSWORD applies an admin-supplied password
immediately and revokes every session on the account. SEND_RESET_EMAIL
dispatches the ordinary self-service reset link so the user picks their
own password; sessions survive until they complete it.
Requires a fresh step-up elevation token: call requestStepUp(password)
and attach the result as X-Elevation: <token>. Without it the mutation
returns STEP_UP_REQUIRED. The target must be a live TenantOwner or
TenantAdmin of tenantId, otherwise TARGET_NOT_TENANT_ADMIN.
Arguments
Lock or unlock configuration editing for a tenant account (platform-admin only). A locked account keeps its Owner/Admin role for navigation but is barred from persisting tenant config & danger-zone changes. Used by the platform-admin tenant Staff view. Takes effect on the account's next access-token refresh.
Arguments
Deprecation reason: Use cancelAccountDeletionResult; BET-205
Arguments
Cancel a pending account deletion request
Arguments
Finish a native "Sign in with Apple": verify the OS-minted id-token and
return the same AuthFlowResponse union as every other login path.
Arguments
Finish "Continue with Google/Apple": exchanges the code, resolves the
account (existing link → verified-email auto-link → sign-up/deny), and
returns the same AuthFlowResponse union as password/passkey login.
Arguments
Arguments
Arguments
Confirm a password reset by submitting either the 4-digit code or the opaque URL token, plus the new password. Revokes all active sessions for the account on success.
Arguments
Create a new account as admin.
Arguments
Create a new permission set.
Arguments
Deprecation reason: Use createSavedLocationResult; BET-205
Arguments
Arguments
Delete the current user's account based on their account type policy
Arguments
Deprecation reason: Use deleteOauthProviderConfigWithValues; BET-205
Arguments
Remove an OAuth app credential for a provider within the given scope.
Arguments
Arguments
Delete a permission set by ID.
Arguments
Arguments
Delete the caller's draft for a form. Idempotent: returns true whether or not a draft existed, meaning none remains.
Arguments
Default
""Grant staff access to a partnership. This allows adding staff members to a partnership. The staff member will be able to switch to this partnership context and perform operations based on their assigned role. Requires: TenantAdmin, PlatformAdmin, PartnershipOwner, or PartnershipManager role.
Arguments
Grant a role to an account
Arguments
Arguments
Deprecation reason: Use logoutResult; BET-205
Arguments
Arguments
Pin a record in the current console. A new pin goes last; pinning an
already pinned record refreshes its label and href and keeps its
place. Tenants can be pinned on the platform admin console; customers,
drivers and orders on the tenant dashboard.
Errors (extensions.code): PINNED_RECORD_KIND_NOT_ALLOWED for a
kind the current console can't pin, PINNED_RECORD_LIMIT_REACHED
when 50 records are already pinned, VALIDATION_ERROR.
Arguments
Record that the caller ran a command-palette entry: adds it to their
history or bumps its useCount, refreshing label, href and
lastUsedAt. Keeps the 20 most recent unpinned entries.
Errors (extensions.code): VALIDATION_ERROR.
Arguments
Arguments
Remove an entry from the caller's command-palette history, pinned or not. Idempotent: returns true whether or not it existed, meaning none remains.
Arguments
Arguments
Put the caller's pins in the order of ids, first to last, and return
them in their new order. Ids that aren't the caller's pins are
ignored; the caller's pins missing from ids keep their relative
order after the listed ones.
Errors (extensions.code): VALIDATION_ERROR when ids repeats a
pin or lists more than 50.
Arguments
Start a self-service password reset by email. Always returns success
regardless of whether the email matches an account — clients should
always proceed to the confirm screen and rely on confirmPasswordReset
to validate the code or token.
Arguments
Mint a single-shot elevation token after re-verifying the
caller's password. Attach the returned token to the
danger-zone mutation as X-Elevation: <token>. The token
expires after 5 minutes or on first successful use, whichever
comes sooner.
Arguments
Sign out every other session of the calling account, keeping the one
making this request. Config-locked accounts get CONFIG_LOCKED.
Revoke staff access from a partnership. This removes a staff member's role for the partnership. They will no longer be able to switch to this partnership context. Requires: TenantAdmin, PlatformAdmin, PartnershipOwner, or PartnershipManager role.
Arguments
Revoke a role from an account
Arguments
Deprecation reason: Use revokeSessionResult; BET-205
Arguments
Arguments
Arguments
Create or overwrite the caller's draft for a form. Every save bumps
revision and pushes expiresAt to 30 days out.
Errors (extensions.code): FORM_DRAFT_CONFLICT (with
extensions.currentRevision) when baseRevision is stale,
FORM_DRAFT_PAYLOAD_TOO_LARGE, FORM_DRAFT_LIMIT_REACHED,
VALIDATION_ERROR.
Arguments
Pin or unpin an entry in the caller's command-palette history.
Errors (extensions.code): COMMAND_RECENT_NOT_FOUND when the caller
has no entry with this id, COMMAND_RECENT_PIN_LIMIT_REACHED when 50
entries are already pinned, COMMAND_RECENT_NOT_PINNABLE for a record
entry (tenant:<uuid>) — records are pinned with pinRecord —
VALIDATION_ERROR.
Arguments
Remember which layout the taxi Dispatch Room shows for the caller in the current console. Saving the same layout again is harmless. Returns the caller's preferences after the save.
Arguments
The layout to show from now on.
Arguments
Begin a native "Sign in with Apple" (the iOS system sheet). Returns the
raw nonce the client SHA-256 hashes into its ASAuthorization request,
and the state it echoes back on completion. No browser round-trip.
Arguments
Begin a passwordless email-OTP login. The supplied email must
belong to an existing, phone-registered, email-verified account
in the resolved tenant — anything else returns a typed error
(EMAIL_NOT_REGISTERED / EMAIL_NOT_VERIFIED) and the client
should route the user back to phone-based registration.
Arguments
Start email verification by sending an OTP code to the provided email. Requires authentication.
Arguments
Begin connecting a provider to the signed-in account.
Arguments
Begin "Continue with Google/Apple": returns the provider authorize URL
and the state the website must store and echo on the callback.
Arguments
Arguments
Begin enrolling a passkey for the authenticated account.
Arguments
Arguments
Switch to a different partnership context or clear partnership context. When switching to a partnership, the system verifies the user has a role with entity_kind=Partnership and entity_id=partnershipId. If authorized, new tokens are issued with the partnership context embedded. Pass null partnershipId to clear partnership context and return to personal account mode.
Arguments
Transfer the TenantOwner role from the calling account to
another account in the same tenant.
Requires a fresh step-up elevation token (Phase 3). The
client first calls requestStepUp(password) to mint a
5-minute single-shot JWT, then attaches it as
X-Elevation: <token> on this mutation. If the header is
missing, malformed, or the token has already been consumed,
the mutation returns STEP_UP_REQUIRED so the client can
prompt for re-auth. The token is only spent once the caller and
target have been validated, so a refused target (for example
TARGET_NOT_TENANT_ADMIN) leaves it usable for a retry.
Both accounts' live console sessions are moved onto their new
roles in the same transaction, so the next token refresh issues
the new claims. Access tokens already issued keep their claims
until they expire; clients should refresh after this mutation.
Arguments
Disconnect a provider from the signed-in account. Refuses to remove the account's last remaining sign-in method.
Arguments
Unpin a record in the current console. Idempotent: returns true whether or not it was pinned, meaning it isn't now.
Arguments
Update an account's profile fields as admin.
Arguments
Update an account's status (Active/Blocked) as admin.
Arguments
Arguments
Update an existing permission set.
Arguments
Arguments
Deprecation reason: Use updateSavedLocationResult; BET-205
Arguments
Arguments
Create or replace an OAuth app credential (Google/Apple). Platform configs require a platform admin; tenant configs are scoped to the caller's tenant. Secrets are write-only — omit to keep the stored value.
Arguments
Verify the OTP from startEmailLogin and mint a session. Returns
the same AuthFlowResponse shape as verifyOtp, so the client
can dispatch on AuthSuccess / RestoreAccountRequired without
branching on which channel sent the code.
Arguments
Verify an email OTP code to confirm the email address. Requires authentication.
Arguments
Arguments
BetterSuite is built for teams who see on-demand as a business — not a feature.