social.colibri.beta.polyfill.listRecords
Lists records of one collection in the requesting user's repo in a space the AppView hosts for them, ordered by record key.
Details · query
| Kind | query |
|---|---|
| Authority | polyfill.beta.colibri.social |
| Commit rev | 3n2beo2y7xt22 |
| 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": "Lists records of one collection in the requesting user's repo in a space the AppView hosts for them, ordered by record key.",
"errors": [
{
"description": "The request has no valid service auth.",
"name": "AuthRequired"
},
{
"description": "The arguments are inconsistent or malformed beyond schema validation.",
"name": "InvalidRequest"
},
{
"description": "No space matches the given space reference.",
"name": "SpaceNotFound"
},
{
"description": "The caller may not write to or read from this repo in the space.",
"name": "NotAuthorized"
},
{
"description": "The AppView does not host the caller's repo in this space, because it lives on the caller's PDS. Write to the PDS instead.",
"name": "RepoNotHosted"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"description": "Where the next page starts.",
"type": "string"
},
"records": {
"description": "The records on this page.",
"items": {
"ref": "social.colibri.beta.polyfill.defs#recordView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"records"
],
"type": "object"
}
},
"parameters": {
"properties": {
"collection": {
"description": "The record's collection.",
"format": "nsid",
"type": "string"
},
"cursor": {
"description": "Where the next page starts.",
"type": "string"
},
"limit": {
"default": 50,
"description": "The page size.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"reverse": {
"description": "Newest record key first.",
"type": "boolean"
},
"space": {
"description": "The space holding the repo.",
"format": "space-ref",
"type": "string"
}
},
"required": [
"space",
"collection"
],
"type": "params"
},
"type": "query"
}
},
"id": "social.colibri.beta.polyfill.listRecords",
"lexicon": 1
}