com.getorbyt.community.listMembers

getorbyt.com

Documentation

A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.

main query

A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.

Parameters

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

cursor string Optional

No description available.

limit integer Optional

No description available.

role string Optional

No description available.

status string Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

No description available.

members array Required

No description available.

Errors

CommunityNotFound
InsufficientRole
InvalidCursor
AuthenticationRequired The request carried no service-auth token, or one this service could not verify for the method. Distinct from InsufficientRole: the caller's identity was never established, so no role decision was made. A client should reauthorize and retry once rather than tell the viewer they lack access.
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
An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).
View raw schema 
{
  "description": "A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.",
  "errors": [
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidCursor"
    },
    {
      "description": "The request carried no service-auth token, or one this service could not verify for the method. Distinct from InsufficientRole: the caller's identity was never established, so no role decision was made. A client should reauthorize and retry once rather than tell the viewer they lack access.",
      "name": "AuthenticationRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "type": "string"
        },
        "members": {
          "items": {
            "ref": "com.getorbyt.community.defs#memberView",
            "type": "ref"
          },
          "maxLength": 50,
          "type": "array"
        }
      },
      "required": [
        "members"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "community": {
        "format": "at-uri",
        "type": "string"
      },
      "cursor": {
        "type": "string"
      },
      "limit": {
        "default": 25,
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      },
      "role": {
        "knownValues": [
          "owner",
          "moderator",
          "member"
        ],
        "type": "string"
      },
      "status": {
        "knownValues": [
          "active",
          "muted",
          "banned"
        ],
        "type": "string"
      }
    },
    "required": [
      "community"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@