Lexicon Garden

rsvp.atmo.space.listRecords

List records of a given collection within a space. Access is governed by the space's collection policy.

Repository @atmo.rsvp did:plc:b63bmauox6z5rbibwrhxrdnw namespace authority
Details · query
Kindquery
Authorityspace.atmo.rsvp
Indexed
Compare Edit in builder → Fork →
cid bafyreiarfrlcx65nhp3nbuumkbvkco7g7b4kfiujorgafjla7jzjqkifrm

Checks

Valid
  • unlimited-string defs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.parameters.properties.inviteTokenNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "List records of a given collection within a space. Access is governed by the space's collection policy.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "Forbidden"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "records": {
              "items": {
                "ref": "rsvp.atmo.space.defs#recordView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "records"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "byUser": {
            "description": "Only return records authored by this DID.",
            "format": "did",
            "type": "string"
          },
          "collection": {
            "format": "nsid",
            "type": "string"
          },
          "cursor": {
            "type": "string"
          },
          "inviteToken": {
            "description": "Read-grant invite token. When supplied, replaces JWT auth for this read.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 200,
            "minimum": 1,
            "type": "integer"
          },
          "spaceUri": {
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "spaceUri",
          "collection"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "rsvp.atmo.space.listRecords",
  "lexicon": 1
}