getCommunitySentInvitations
query should be called.
The query result contains pagination and it is possible to change the sorting order and key.
Supports cursor-based (after
, before
) or limit-based (first
, last
) pagination.
Query results will be available only for the user associated with the community owner context
or users associated with
ADMINISTRATOR
scope.Argument | Type | Description | Default |
---|---|---|---|
communityId | ID | Required. ID of the community to get the list of sent invitations. | — |
after | Cursor | Returns results that come after the specified cursor. Should be used together with first parameter. Cannot be used if before is set. | — |
before | Cursor | Returns results that come before the specified cursor. Should be used together with last parameter. Cannot be used if after is set. | — |
first | Integer | Returns up to the first N elements from the list. Required if after parameter is set. Cannot be used together with last . | — |
last | Integer | Returns up to the first N elements from the list. Required if before parameter is set. Cannot be used together with first . | — |
reverse | Boolean | Allows to change the order of the sorting to DESC . | false |
sortKey | CommunityInvitationSortKey | Provides the possibility to change the query sorting key. Available options: CREATED (sorting by the invitation creation date) or NAME (by the invitee user context name). | CREATED |
CommunityInvatation
object, the full description can be found here.