Skip to main content
GET
cURL
Returns the organization’s invitations that are still outstanding: not yet accepted, not revoked, and (for an expired one) still the most recent invitation sent to that address. Once somebody accepts, they stop being an invitation and become a member, so they drop off this list. To see them after that, read the member list in the app under Members.
One row per address. Resending does not create a second invitation, so an address you have chased three times still appears once, with the latest expires_at.

Response

An array of organization invitation objects. This endpoint is not paginated.
created_by, user, and workspace are ids by default. Pass expand[] to get the objects instead. expand[]=workspace_memberships adds the workspaces the invitee is already in, with their role in each.
See Expanding Responses.

Find what has gone stale

An expired invitation still holds every workspace, group, and grant attached to it: the link stopped working, the access did not. Resending re-opens it without re-granting anything.

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
integer
required
read-only

The user who sent the invitation. (Expandable)

user
integer | null
required
read-only

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

workspace
string<uuid> | null
required
read-only

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