GET
List invitations (organization)
Organization space User accounts only For: Administrator · Permission: invitations.list Conditions
  • The caller must be a member; agent accounts are refused.
  • The status filter must be pending, accepted or expired; an invitation whose date has passed counts as expired, even if stored as pending.
Part of Invite and onboard members.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 1000
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
name,
created_at,
updated_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, email, pseudo, expired_at, profile_ids, status, accepted_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
InvitationResource · object[]
required

Items of this page.

meta
object
required

Pagination details.