DocsAPI reference

Auth API

Accounts and sessions: registration and email verification, password and one-time-code sign-in, Google sign-in, multi-factor authentication, linked identities, and accepting a team or staff invitation.

On this page

Endpoints#

34 operations, each with its parameters, schemas and an example request on its own page.

Authentication#

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

TokenResponse7 fields
  • access_tokenstringrequired
  • expires_inintegerrequired
  • organizationOrgReadrequired
    10 fieldsOrgRead
    • idstringrequired
    • namestringrequired
    • plan_tierstringrequired
    • roleOrgRole | stringrequired
    • slugstringrequired
    • accessstring

      One of: member, agency·Default: member

    • is_activeboolean

      Default: true

    • is_currentboolean

      Default: false

    • is_defaultboolean

      Default: false

    • parent_org_idstring | null
  • userUserReadrequired
    9 fieldsUserRead
    • created_atstring (date-time)required
    • emailstringrequired
    • full_namestringrequired
    • idstringrequired
    • is_activebooleanrequired
    • is_verifiedbooleanrequired
    • avatar_urlstring | null
    • is_staffboolean

      Default: false

    • staff_levelstring | null

      One of: view, edit, owner

  • refresh_tokenstring | null
  • supportSupportSessionInfo | null

    Present on a token issued inside a staff support session.

    What the customer surfaces need to draw the banner that says so - whose workspace, whether changes are allowed, and when it ends by itself.

    5 fieldsSupportSessionInfo
    • expires_atstring (date-time)required
    • org_idstringrequired
    • org_namestringrequired
    • session_idstringrequired
    • writebooleanrequired
  • token_typestring

    Default: bearer

Message2 fields
  • messagestringrequired
  • okboolean

    Default: true

GoogleStartResponse5 fields
  • authorization_urlstringrequired
  • code_verifierstringrequired
  • noncestringrequired
  • redirect_uristringrequired
  • statestringrequired
IdentityRead4 fields
  • created_atstring (date-time)required
  • providerstringrequired
  • emailstring | null
  • last_login_atstring (date-time) | null
InvitationPreview7 fields
  • emailstringrequired
  • expires_atstring (date-time)required
  • organization_namestringrequired
  • organization_slugstringrequired
  • roleOrgRole | stringrequired
  • has_accountboolean

    Default: false

  • invited_bystring | null
UserRead9 fields
  • created_atstring (date-time)required
  • emailstringrequired
  • full_namestringrequired
  • idstringrequired
  • is_activebooleanrequired
  • is_verifiedbooleanrequired
  • avatar_urlstring | null
  • is_staffboolean

    Default: false

  • staff_levelstring | null

    One of: view, edit, owner

MfaStatus5 fields
  • enabledbooleanrequired
  • activated_atstring (date-time) | null
  • pendingboolean

    Default: false

  • recovery_codes_remaininginteger

    Default: 0

  • recovery_generated_atstring (date-time) | null
MfaCodesResponse2 fields
  • generated_atstring (date-time)required
  • recovery_codesarray of stringrequired
MfaSetupResponse5 fields
  • digitsintegerrequired
  • manual_keystringrequired
  • period_secondsintegerrequired
  • secretstringrequired
  • uristringrequired
OrgRead10 fields
  • idstringrequired
  • namestringrequired
  • plan_tierstringrequired
  • roleOrgRole | stringrequired
  • slugstringrequired
  • accessstring

    One of: member, agency·Default: member

  • is_activeboolean

    Default: true

  • is_currentboolean

    Default: false

  • is_defaultboolean

    Default: false

  • parent_org_idstring | null

Something unclear or missing? Tell us and we’ll fix it.