Skip to main content
Get an organization invitation

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string
required
Required string length: 1 - 255

Query Parameters

fields
string

Return only these fields, comma-separated. id is always returned. Fields: id, email, role, status, created_at, expires_at.

Response

Invitation detail.

id
string
required
Required string length: 1 - 255
email
string<email>
required
role
enum<string>
required
Available options:
admin,
member,
unsupported
status
enum<string> | null
required
Available options:
pending,
accepted,
revoked,
expired,
null
created_at
string<date-time>
required
expires_at
string<date-time>
required