invite-example.json
{
  "id": "01887270-45ab-7da0-c95d-9a9e9ebc5e89",
  "email": "jane@acme.com",
  "code": "ab3d5f8g",
  "role": "member",
  "expiresAt": "2023-09-15T00:00:00Z",
  "createdAt": "2023-08-15T08:30:00Z",
  "isUrlInvite": false,
  "groups": [
    {
      "id": "01887270-56cd-7da0-c95d-9a9e9ebc6f90",
      "name": "Engineering"
    }
  ]
}

Invite Object

id
string

Unique identifier for the invite

email
string

Email address of the invitee

code
string

Invite code

role
string

Role assigned to the invitee. Possible values: admin, member

expiresAt
string

ISO8601 timestamp when the invite expires

createdAt
string

ISO8601 timestamp when the invite was created

isUrlInvite
boolean

Whether this is a URL-based invite

groups
array

User groups assigned to the invite