Skip to main content
POST
List invitations

Authorizations

Authorization
string
header
required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json
target_type
enum<string>

org or realm. Defaults to org when org_id is sent.

Available options:
org,
realm
org_id
string<uuid>

The organization.

realm_id
string

The realm.

Minimum string length: 1
status
enum<string>

Only invitations in this status (a pending one past its expiry counts as expired).

Available options:
pending,
accepted,
declined,
revoked,
expired
query
string

Matches part of the email.

sort
string

Field to sort by, with - first for descending. Default -created_at.

page
integer

Page number, from 1.

Required range: x >= 1
page_size
integer

Page size (at most 100).

Required range: 1 <= x <= 100

Response

Success.

ok
enum<boolean>
required

Always true on success.

Available options:
true
data
object
required