social.colibri.beta.community.listRoles Documentation (EN)

main query

Lists a community's roles.

Parameters

community string did Required

The community to list roles of.

Output

Encodingapplication/json

roles array Required

The community's roles.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.

Forbidden The requesting user lacks permission to view this community's roles.

CommunityNotFound No community exists with that DID.

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 * The community to list roles of.

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 view this community's roles."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "roles"
      ],
      "properties": {
        "roles": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.community.defs#roleView",
            "type": "ref"
          },
          "description": "The community's roles."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "community": {
        "type": "string",
        "format": "did",
        "description": "The community to list roles of."
      }
    }
  },
  "description": "Lists a community's roles."
}