social.coves.aggregator.getAuthorizations Documentation (EN)

main query

Get list of communities that have authorized a specific aggregator. Used by aggregators to query which communities they can post to. Authentication optional.

Parameters

aggregatorDid string did Required

DID of the aggregator

cursor string Optional

Pagination cursor

enabledOnly boolean Optional

Only return enabled authorizations

limit integer Optional

Maximum number of authorizations to return

Output

Encodingapplication/json

authorizations array Required

Array of community authorizations for this aggregator

cursor string Optional

Pagination cursor for next page

Errors

AggregatorNotFound Aggregator DID does not exist or has no service declaration

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

aggregatorDid * DID of the aggregator

cursor Pagination cursor

enabledOnly Only return enabled authorizations

limit Maximum number of authorizations to return

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AggregatorNotFound",
      "description": "Aggregator DID does not exist or has no service declaration"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "authorizations"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "maxLength": 500,
          "description": "Pagination cursor for next page"
        },
        "authorizations": {
          "type": "array",
          "items": {
            "ref": "social.coves.aggregator.defs#communityAuthView",
            "type": "ref"
          },
          "description": "Array of community authorizations for this aggregator"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "aggregatorDid"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of authorizations to return"
      },
      "cursor": {
        "type": "string",
        "maxLength": 500,
        "description": "Pagination cursor"
      },
      "enabledOnly": {
        "type": "boolean",
        "default": true,
        "description": "Only return enabled authorizations"
      },
      "aggregatorDid": {
        "type": "string",
        "format": "did",
        "description": "DID of the aggregator"
      }
    }
  },
  "description": "Get list of communities that have authorized a specific aggregator. Used by aggregators to query which communities they can post to. Authentication optional."
}