blue.catbird.circle.listCircles Documentation (EN)

main query

List Circle Spaces accessible to the caller

Parameters

cursor string Optional

No description available.

limit integer Optional

No description available.

Output

Encodingapplication/json

circles array Required

No description available.

cursor string Optional

No description available.

Errors

AuthRequired

AccessRemoved

UnsupportedPDS

ProtocolRevisionMismatch

UpstreamUnavailable

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

cursor

limit

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired"
    },
    {
      "name": "AccessRemoved"
    },
    {
      "name": "UnsupportedPDS"
    },
    {
      "name": "ProtocolRevisionMismatch"
    },
    {
      "name": "UpstreamUnavailable"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "circles"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "circles": {
          "type": "array",
          "items": {
            "ref": "blue.catbird.circle.defs#circleSummary",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      }
    }
  },
  "description": "List Circle Spaces accessible to the caller"
}