Skip to main content
GET
cURL
Legacy endpoint. /api/v1/invitations/ predates workspaces. It keeps working for existing integrations. New integrations should use List Invitations, which also returns the invitee’s user and the workspace each invitation was issued in.
Returns the same invitations as List Invitations, as legacy invitation objects: role instead of organization_role, created_by always nested, and no user or workspace.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Response

200 - application/json
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
read-only
revoked_at
string<date-time> | null
required
read-only
created_at
string<date-time>
required
read-only
created_by
object
required
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
role
enum<string>
default:member

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