social.coves.aggregator.listForCommunity Documentation (EN)

main query

List all aggregators authorized for a specific community. Used by community settings UI to show enabled/disabled aggregators. Authentication optional.

Parameters

community string at-identifier Required

DID or handle of the community

cursor string Optional

Pagination cursor

enabledOnly boolean Optional

Only return enabled aggregators

limit integer Optional

Maximum number of aggregators to return

Output

Encodingapplication/json

aggregators array Required

Array of aggregator authorizations for this community

cursor string Optional

Pagination cursor for next page

Errors

CommunityNotFound Community not found

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 * DID or handle of the community

cursor Pagination cursor

enabledOnly Only return enabled aggregators

limit Maximum number of aggregators to return

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "CommunityNotFound",
      "description": "Community not found"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "aggregators"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "maxLength": 500,
          "description": "Pagination cursor for next page"
        },
        "aggregators": {
          "type": "array",
          "items": {
            "ref": "social.coves.aggregator.defs#authorizationView",
            "type": "ref"
          },
          "description": "Array of aggregator authorizations for this community"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of aggregators to return"
      },
      "cursor": {
        "type": "string",
        "maxLength": 500,
        "description": "Pagination cursor"
      },
      "community": {
        "type": "string",
        "format": "at-identifier",
        "description": "DID or handle of the community"
      },
      "enabledOnly": {
        "type": "boolean",
        "default": false,
        "description": "Only return enabled aggregators"
      }
    }
  },
  "description": "List all aggregators authorized for a specific community. Used by community settings UI to show enabled/disabled aggregators. Authentication optional."
}