Skip to main content
GET
cURL
Returns the organization’s outstanding invitations whose invitee already has a place in the API key’s workspace, each with the role waiting for them there. Use it to see who is pending in a workspace without needing organization-level rights.

Response

An array of workspace invitation objects, newest first. This endpoint is not paginated.
created_by and user are ids; pass expand[]=created_by or expand[]=user to get the objects. Unlike the organization’s list, there is no workspace field: the workspace that issued the invitation may be one you cannot see.

Example

Authentication

This endpoint requires an API key created by a workspace admin of the key’s workspace. Organization owners and admins are admins of every 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
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
read-only
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_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.