Overview

Workspace invitations let admins invite users to join a workspace with specific access settings.

Learn more about members

The workspace invitation object

Attributes

• id string

  Unique identifier for the invitation.

• email string

  Email address of the invited user.

• role integer

  Workspace role granted to the invited user. One of:

  • 20: Admin
  • 15: Member
  • 5: Guest

• created_at string

  When the invitation was created.

• updated_at string

  When the invitation was last updated.

• responded_at string

  When the invited user responded to the invitation.

• accepted boolean

  Whether the invited user accepted the invitation.

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "Example Name",
  "role": 20,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "responded_at": "2024-01-01T00:00:00Z",
  "accepted": true
}