Docs

API reference · Identity and tokens

What the invitation of a link offers the signed-in caller

POST/v1/invitations/preview
Permission
authenticated: any signed-in caller or API token
Operation
iam.invitations.preview

Request body

FieldTypeRequiredNotes
tokenstringyes1 to 200 characters

Response 200

FieldTypeRequiredNotes
organizationobjectyes
organization.idstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
organization.namestringyes
rolestringyesone of "owner", "admin", "member"
emailstring (email)yes
invitedBystring or nullyes
expiresAtstring (date-time)yesUTC, ISO 8601.
emailMatchesbooleanyes
emailVerifiedbooleanyes