DocsAPI reference

Preview a staff invitation

The terms of the offer, for the acceptance page.

get/api/auth/staff-invitation
Authentication
None
Retries
Safe to repeat
Body
None
Version
2026-09-03

A GET with the token in the query string, because the recipient arrives by clicking a link in an email. That does put the token in browser history, so it is single-use, expires in seven days, and the page removes it from the address bar once read.

Query parameters#

  • tokenstringrequired

Responses#

  • 200OKapplication/json

    StaffInvitationPreview

    • emailstringrequired
    • expires_atstring (date-time)required
    • staff_levelstringrequired

      One of: view, edit, owner

    • access_untilstring (date-time) | null
    • full_namestring | null
    • has_accountboolean

      Default: false

    • invited_bystring | null
    • needs_passwordboolean

      Default: true

    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Auth endpoints#

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