com.getorbyt.community.listRoles Documentation (EN)

main query

The Community's roles: the built-in owner and moderator roles, then the roles the Community defined, in order. Requires manage-roles. Viewer-specific and never cached.

Parameters

community string at-uri Required

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

Output

Encodingapplication/json

roles array Required

No description available.

viewerActions array Optional

What this viewer may do to the list itself, decided by the service. Absent means nothing.

Errors

AuthenticationRequired

CommunityNotFound

InsufficientRole

InvalidRequest

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

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

View raw schema

{
  "description": "The Community's roles: the built-in owner and moderator roles, then the roles the Community defined, in order. Requires manage-roles. Viewer-specific and never cached.",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "roles": {
          "items": {
            "ref": "com.getorbyt.community.defs#roleView",
            "type": "ref"
          },
          "maxLength": 32,
          "type": "array"
        },
        "viewerActions": {
          "description": "What this viewer may do to the list itself, decided by the service. Absent means nothing.",
          "items": {
            "knownValues": [
              "createRole"
            ],
            "type": "string"
          },
          "maxLength": 8,
          "type": "array"
        }
      },
      "required": [
        "roles"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "community": {
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "community"
    ],
    "type": "params"
  },
  "type": "query"
}