Skip to main content
GET
List invitations for an organization

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

invite:read

Path Parameters

organizationID
string
required

Unique identifier for a specific organization

Pattern: [a-zA-Z0-9_-~:]+

Query Parameters

status
enum<string>

Filter invitations by status

Available options:
pending,
expired
email
string

Filter invitations by email address

first_name
string

Filter invitations by first name

last_name
string

Filter invitations by last name

Search invitations by email or name

first
integer
default:0

Index of the first result to return (0-based offset for pagination)

Required range: x >= 0
max
integer
default:100

Maximum number of results to return

Required range: 1 <= x <= 100

Response

List of invitations retrieved successfully

invitations
object[]
required