InviteSummary

What an invite is for, shown to the person accepting it before they register.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
id	uuid	The invite’s id.
code	string	The invitation code the invite was sent with.
emailAddress	string	The e-mail address the invite was sent to.
isInviteToTenant	boolean	Whether the invite joins an existing tenant (true) or registers a new one (false).
tenantName	string | null	The name of the tenant the invite joins; null for an invite to register a new tenant.

Example

{
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "code": "...",
  "emailAddress": "...",
  "isInviteToTenant": false,
  "tenantName": "..."
}