GET/api/v1/invites/{token}

Preview an invitation

What an invitation link is for: the workspace, the role and whether it is still open. Answers 200 for invitations already accepted or withdrawn too, saying so.

Token optional60 per minute per IP
Code samples and Try it

Path parameters

#
  • tokenstringRequired

    The token from the invitation link.

Responses

#
  • 200OK.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
200 response: 12 fields (InvitePreview)
  • workspace_namestring
  • role"owner" | "admin" | "member" | "viewer"
  • emailstring
  • invited_by_namestring | null
  • status"pending" | "accepted" | "declined" | "revoked" | "expired"
  • expires_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • signed_in_asstring | null
  • email_matchesboolean

    Default false.

  • already_memberboolean

    Default false.

  • logo_urlstring | null
  • accent_colorstring | null
  • logo_well"light" | "dark" | "checker" | null
Did this page help?