Skip to main content

A pending invitation to the organization whose invitee already has a place in your current workspace. organization_role is the role in the organization the invitation grants, and workspace_role the role waiting for the invitee in this workspace. created_by and user are ids, each expandable.

id
string<uuid>
required
read-only
first_name
string
required
read-only
last_name
string
required
read-only
email
string<email>
required
read-only
organization_role
string
required
read-only

The invitee's role in the organization.

functional_area
required
  • data_analytics - Data & Analytics
  • sales - Sales
  • customer_support - Customer Support
  • operations - Operations
  • marketing - Marketing
  • finance - Finance
  • product_development - Product Development
  • growth - Growth
  • executive_leadership - Executive Leadership
  • other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
required
sent_at
string<date-time>
required
read-only
expires_at
string<date-time>
required
read-only
accepted_at
string<date-time> | null
required
revoked_at
string<date-time> | null
required
created_at
string<date-time>
required
read-only
created_by
integer
required
read-only

The user who sent the invitation. (Expandable)

user
integer | null
required

The user the invitation created, pending in the organization until they accept. (Expandable)

workspace_role
string
required
read-only

The role waiting for the invitee in this workspace.

shared
boolean
required
read-only

Whether the invitation reaches beyond this workspace: issued elsewhere, or its invitee is in another workspace too. A shared invitation is revoked from the organization's invitations, not here.