social.colibri.beta.community.listMembers

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Lists a community's admitted members.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The requesting user lacks permission to list this community's members.",
          "name": "Forbidden"
        },
        {
          "description": "No community exists with that DID.",
          "name": "CommunityNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "A cursor for fetching the next page.",
              "type": "string"
            },
            "members": {
              "description": "The community's members.",
              "items": {
                "ref": "social.colibri.beta.community.defs#memberView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "members"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "description": "The community to list members of.",
            "format": "did",
            "type": "string"
          },
          "cursor": {
            "description": "The cursor from a previous call, for fetching the next page.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "The maximum number of results to return.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "role": {
            "description": "Filters to members holding this role.",
            "format": "record-key",
            "type": "string"
          }
        },
        "required": [
          "community"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.community.listMembers",
  "lexicon": 1
}