Skip to main content

An invitation as organization/invitations/ answers it: invitations/'s fields, plus the user it created (pending in the organization until they accept) and the workspace it was issued in (a workspace invitation, specs/workspaces.md §4.9a; null for an organization one). created_by, user and workspace are ids, each expandable. organization_role is the role in the organization the invitation grants, invitations/'s role.

id
string<uuid>
required
read-only
email
string<email>
required
Maximum string length: 254
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
string<uuid> | null
required

The workspace the invitation was issued in; null for an organization invitation. (Expandable)

first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
organization_role
enum<string>
default:member

The invitee's role in the organization. Defaults to member. You cannot invite somebody to a role above your own, and on the Free plan only owners can be invited.

  • owner - Owner
  • admin - Admin
  • member - Member
Available options:
owner,
admin,
member
functional_area
  • 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
Maximum string length: 128
workspaces
object[]
write-only

Workspaces to place the invitee in right away, each with their role there; the invitation still belongs to the organization. An owner or admin is an admin of every workspace: omit workspaces for them, or list every workspace as admin. No workspace twice.