social.colibri.beta.community.listInvitations

colibri.social

Documentation

Lists a community's invitation codes.

main query

Lists a community's invitation codes.

Parameters

community string did Required

The community to list invitations for.

cursor string Optional

The cursor from a previous call, for fetching the next page.

limit integer Optional

The maximum number of results to return.

Output

Encodingapplication/json
cursor string Optional

A cursor for fetching the next page.

invitations array Required

The community's invitations.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The requesting user lacks the invitation.create permission.
CommunityNotFound No community exists with that DID.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The community to list invitations for.
The cursor from a previous call, for fetching the next page.
The maximum number of results to return.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user lacks the invitation.create permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "invitations"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "A cursor for fetching the next page."
        },
        "invitations": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.community.defs#invitationView",
            "type": "ref"
          },
          "description": "The community's invitations."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "The maximum number of results to return."
      },
      "cursor": {
        "type": "string",
        "description": "The cursor from a previous call, for fetching the next page."
      },
      "community": {
        "type": "string",
        "format": "did",
        "description": "The community to list invitations for."
      }
    }
  },
  "description": "Lists a community's invitation codes."
}

Lexicon Garden

@