Skip to content
Browse docslist_invitations

list_invitations

Lists a page of your own open invitation links for a group you currently moderate.

Annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false

When to use it#

Before inviting someone again, after an uncertain issuance response, or to send an existing link yourself. Only links the member created that can still admit someone are listed: not revoked, not expired, not used up. Partially used links remain listed. Another moderator's links and addressees are private.

An active member who does not moderate the group receives request_rejected with new_request recovery. A missing or inaccessible group is unavailable. An authorized moderator with no open links receives an empty successful page. Every page checks current authority.

Inputs#

InputRequiredTypeDescription
groupPublicIdyesstringThe group's ID from list_groups.
pageSizenointegerNonnegative; omitted or 0 uses 20, values above 100 cap at 100.
pageTokennostringThe previous page's nextPageToken; omitted or empty starts the list.

Returns#

{ "invitations": [...], "nextPageToken": "..." }, newest creation first, then stable invitation ID ascending for ties. IDs are internal to ordering and continuation. Each invitation has:

FieldTypeDescription
recipientEmailstring or nullThe intended address when known; it does not restrict who can join or establish that the link was sent
invitationUrlstringThe link, which the member can send again
createdAt, expiresAtstringISO 8601 timestamps
remainingUsesnumberHow many more people the link admits

Continue until nextPageToken is empty before claiming complete coverage, including after an empty page with continuation. Tokens are opaque, private, bound to the member and group, and expire after one hour. Keep the group unchanged on continuation; page size may change. An invalid, expired, or mismatched token returns invalid_argument: restart without a token.

Pages are live reads, not a snapshot across calls. Links can expire, fill up, or be revoked between pages. Absence from this open-link collection cannot prove that an uncertain issuance never committed. Reading creates, renews, and sends nothing. Exact invitation history and lost-draft recovery are unsupported.

Example#

json
{
  "groupPublicId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "pageSize": 20
}

Result (synthetic data):

json
{
  "invitations": [
    {
      "recipientEmail": "pat@example.test",
      "invitationUrl": "https://invites.example.test/join/cccccccccccccccccccccccccccccccc",
      "createdAt": "2026-10-09T00:00:00.000Z",
      "expiresAt": "2026-10-23T00:00:00.000Z",
      "remainingUses": 10
    }
  ],
  "nextPageToken": ""
}