Skip to main content
GET
Search invitations

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Query Parameters

Offset
integer<int32>
Required range: 0 <= x <= 2147483647
Limit
integer<int32>
Required range: 1 <= x <= 500
Status
string[]

Pending (when omitted), Accepted, Expired or Cancelled; repeat the parameter for more than one.

Filter by invitations whose email address contains the specified text, ignoring case.

Example:

"jane"

Response

When the request is successful. Returns a paged collection of 'Invitation' objects.

A page of invitations.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
self
object | null
value
object[] | null
offset
integer<int32> | null
limit
integer<int32> | null
size
integer<int64>
first
object | null
previous
object | null
next
object | null
last
object | null