rsvp.atmo.space.listRecords

atmo.rsvp

Documentation

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

main query

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

Parameters

byUser string did Optional

Only return records authored by this DID.

collection string nsid Required

A namespaced identifier (e.g., app.bsky.feed.post).

cursor string Optional

No description available.

inviteToken string Optional

Read-grant invite token. When supplied, replaces JWT auth for this read.

limit integer Optional

No description available.

spaceUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Output

Encodingapplication/json
cursor string Optional

No description available.

records array Required

No description available.

Errors

NotFound
Forbidden
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only return records authored by this DID.
A namespaced identifier (e.g., app.bsky.feed.post).
Read-grant invite token. When supplied, replaces JWT auth for this read.
An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "NotFound"
    },
    {
      "name": "Forbidden"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "records"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "records": {
          "type": "array",
          "items": {
            "ref": "rsvp.atmo.space.defs#recordView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "spaceUri",
      "collection"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 200,
        "minimum": 1
      },
      "byUser": {
        "type": "string",
        "format": "did",
        "description": "Only return records authored by this DID."
      },
      "cursor": {
        "type": "string"
      },
      "spaceUri": {
        "type": "string",
        "format": "at-uri"
      },
      "collection": {
        "type": "string",
        "format": "nsid"
      },
      "inviteToken": {
        "type": "string",
        "description": "Read-grant invite token. When supplied, replaces JWT auth for this read."
      }
    }
  },
  "description": "List records of a given collection within a space. Access is governed by the space's collection policy."
}

Lexicon Garden

@