1. Docs
  2. API Reference
  3. Look up invite details by token

Look up invite details by token

POST/v1/auth/invite-info

Public lookup of a pending admin invite by its raw token, so the accept-invite page can prefill the form. POST (rate-limited to 10 per minute) returning the invitee's email, first_name, last_name, and an sso_available flag that is true when the Account has an active admin SSO connection covering the invitee's domain. Returns 400 when the token is unknown, expired, or the invite is no longer pending.

Request body

application/json

tokenstring Required

Invite token from the email link

Responses

application/json

  • dataInviteInfoResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Rate limit

10 requests per 1mPer caller: the signed-in user for a bearer token; for an API key, the key and the end user's address when a backend forwards it, otherwise the client address

Returned object

InviteInfoResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/invite-info" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string"
  }'
Response
{
  "data": {
    "email": "string",
    "intent": "activate",
    "organization_name": "string",
    "node_name": "string",
    "role_name": "string",
    "effective_from": "2026-04-20T12:00:00.000Z",
    "effective_to": "2026-04-20T12:00:00.000Z",
    "inviter_name": "string",
    "proof_methods": [
      "password"
    ],
    "first_name": "string",
    "last_name": "string",
    "app_name": "string",
    "inviter_email": "string",
    "sso_available": false
  }
}
 Related endpoints
POSTRegister a new user
POSTCreate an additional Account for the authenticated admin (no new user)
GETReview the parked account-creation intent before resuming
POSTResume a deferred account creation parked at the register form
DELETEDismiss the parked account-creation intent without creating anything
POSTAccept an invite
POSTAuthenticate and receive tokens
POSTSelect an Account from a pre-auth session (multi-Account login)
POSTSwitch the active Application in an authenticated session
POSTRefresh access token
POSTLogout and revoke tokens
GETVerify email address
POSTResend verification email
POSTResend verification email by token
POSTRequest password reset
POSTReset password with token
POSTChange password (authenticated)
GETGet current user profile
GETGet current user avatar image
POSTUpload profile avatar
DELETERemove profile avatar
POSTRequest an email-address change
POSTConfirm an email-address change
GETGet current user permissions
GETList the Accounts the current user belongs to
GETList active sessions
DELETERevoke all sessions
DELETERevoke a specific session
 Was this page helpful?

Tell us how we can improve this guide.

Canopy