Skip to content

Team

Preview an invite

Public endpoint used by the invite page. It reveals only the invited email, role, workspace name, expiry and status.

GET/api/invites/{token}
  • Public, no authentication

Path parameters

  • tokenstringrequired

    The token from the invite link (/invite?token=…).

    Example
    f3a9…

Response

200 OKapplication/json

  • emailstring

    Invited email address.

  • roleenum

    admin or agent.

  • workspace_namestring

    Name of the workspace.

  • expires_atinteger

    Expiry in Unix seconds.

  • statusstring

    pending, accepted or revoked; a pending invite whose expiry has passed shows expired. Only a pending invite can be accepted.

Status codes

  • 200OK. The invite details.
  • 404Not found. The token is unknown or malformed.