social.colibri.beta.community.listMembers

colibri.social

Documentation

Lists a community's admitted members.

main query

Lists a community's admitted members.

Parameters

community string did Required

The community to list members of.

cursor string Optional

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

limit integer Optional

The maximum number of results to return.

role string record-key Optional

Filters to members holding this role.

Output

Encodingapplication/json
cursor string Optional

A cursor for fetching the next page.

members array Required

The community's members.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The requesting user lacks permission to list this community's members.
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 members of.
The cursor from a previous call, for fetching the next page.
The maximum number of results to return.
Filters to members holding this role.
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 permission to list this community's members."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "members"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "A cursor for fetching the next page."
        },
        "members": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.community.defs#memberView",
            "type": "ref"
          },
          "description": "The community's members."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "role": {
        "type": "string",
        "format": "record-key",
        "description": "Filters to members holding this role."
      },
      "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 members of."
      }
    }
  },
  "description": "Lists a community's admitted members."
}

Lexicon Garden

@