API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Staff

AdminUpdated Sep 11, 2026

Staff

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

4 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/staff/accounts

staff: search customer accounts. Requires the staff instance, an MFA-verified session and an allowlisted IP.

GET /v1/staff/accounts/:accountId

staff: one account with its applications and instances. Read-only; user counts, never user lists.

GET /v1/staff/platform_switches

staff: read the global kill switches. Staff instance, MFA and IP allowlist.

PATCH /v1/staff/platform_switches

staff: flip the global kill switches (read-only mode, disable all sign-ups). Audited.

Was this page helpful?