ooo.bsky.authfetch.listRecords

lexicon.store

Documentation

Lists a range of private records in a hidden repository that match a specific collection. Requires auth.

main query

Lists a range of private records in a hidden repository that match a specific collection. Requires auth.

Parameters

collection string nsid Required

The NSID of the record collection.

cursor string Optional

No description available.

limit integer Optional

The number of records to return.

reverse boolean Optional

Flag to reverse the order of the returned records.

Output

Encodingapplication/json
cursor string Optional

No description available.

records array Required

No description available.

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
The NSID of the record collection.
The number of records to return.
Flag to reverse the order of the returned records.
View raw schema
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "records"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "records": {
          "type": "array",
          "items": {
            "ref": "#record",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "collection"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "The number of records to return."
      },
      "cursor": {
        "type": "string"
      },
      "reverse": {
        "type": "boolean",
        "description": "Flag to reverse the order of the returned records."
      },
      "collection": {
        "type": "string",
        "format": "nsid",
        "description": "The NSID of the record collection."
      }
    }
  },
  "description": "Lists a range of private records in a hidden repository that match a specific collection. Requires auth."
}
record object

A record in the hidden repository.

Properties

uri string at-uri Required

The AT URI of the record.

value unknown Required

The stored private record value.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "strategy",
    "value"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT URI of the record."
    },
    "value": {
      "type": "unknown",
      "description": "The stored private record value."
    },
    "strategy": {
      "ref": "ooo.bsky.authfetch.strategy",
      "type": "ref",
      "description": "The strategy used to authenticate fetch requests for this record."
    }
  },
  "description": "A record in the hidden repository."
}

Lexicon Garden

@