pub.chive.collection.get Documentation (EN)

main query

Get a single collection by its AT-URI

Parameters

excludeSubcollectionItems boolean Optional

When true, exclude items that also appear in subcollections

uri string Required

AT-URI of the collection

Output

Encodingapplication/json

collection refpub.chive.collection.defs#collectionView Required

The requested collection

interItemEdges array Required

Edges between items within this collection

items array Required

Items contained in the collection

subcollections array Required

Child subcollections

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

excludeSubcollectionItems When true, exclude items that also appear in subcollections

uri * AT-URI of the collection

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "collection",
        "items",
        "subcollections",
        "interItemEdges"
      ],
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "ref": "pub.chive.collection.defs#collectionItemView",
            "type": "ref"
          },
          "description": "Items contained in the collection"
        },
        "collection": {
          "ref": "pub.chive.collection.defs#collectionView",
          "type": "ref",
          "description": "The requested collection"
        },
        "interItemEdges": {
          "type": "array",
          "items": {
            "ref": "pub.chive.collection.defs#interItemEdgeView",
            "type": "ref"
          },
          "description": "Edges between items within this collection"
        },
        "subcollections": {
          "type": "array",
          "items": {
            "ref": "pub.chive.collection.defs#collectionView",
            "type": "ref"
          },
          "description": "Child subcollections"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "uri"
    ],
    "properties": {
      "uri": {
        "type": "string",
        "description": "AT-URI of the collection"
      },
      "excludeSubcollectionItems": {
        "type": "boolean",
        "description": "When true, exclude items that also appear in subcollections"
      }
    }
  },
  "description": "Get a single collection by its AT-URI"
}