is.currents.graph.getFavouriteCollections
Enumerate collections the given actor has favourited, most recent first. Auth is optional; if provided, viewer-specific state is included in each collection.
Details · query
| Kind | query |
|---|---|
| Authority | graph.currents.is |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Enumerate collections the given actor has favourited, most recent first. Auth is optional; if provided, viewer-specific state is included in each collection.",
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"collections": {
"items": {
"ref": "is.currents.feed.defs#collectionView",
"type": "ref"
},
"type": "array"
},
"cursor": {
"type": "string"
}
},
"required": [
"collections"
],
"type": "object"
}
},
"parameters": {
"properties": {
"actor": {
"description": "DID or handle of the actor whose favourited collections to list.",
"format": "at-identifier",
"type": "string"
},
"cursor": {
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"actor"
],
"type": "params"
},
"type": "query"
}
},
"id": "is.currents.graph.getFavouriteCollections",
"lexicon": 1
}