com.atproto.repo.getRecord Documentation (EN)

main query

Get a single record from a repository. Does not require auth.

Parameters

cid string cid Optional

The CID of the version of the record. If not specified, then return the most recent version.

collection string nsid Required

The NSID of the record collection.

repo string at-identifier Required

The handle or DID of the repo.

rkey string record-key Required

The Record Key.

Output

Encodingapplication/json

cid stringcid Optional

A content identifier (CID) referencing immutable data.

uri stringat-uri Required

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

value unknown Required

No description available.

Errors

RecordNotFound

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "description": "Get a single record from a repository. Does not require auth.",
  "errors": [
    {
      "name": "RecordNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "value": {
          "type": "unknown"
        }
      },
      "required": [
        "uri",
        "value"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cid": {
        "description": "The CID of the version of the record. If not specified, then return the most recent version.",
        "format": "cid",
        "type": "string"
      },
      "collection": {
        "description": "The NSID of the record collection.",
        "format": "nsid",
        "type": "string"
      },
      "repo": {
        "description": "The handle or DID of the repo.",
        "format": "at-identifier",
        "type": "string"
      },
      "rkey": {
        "description": "The Record Key.",
        "format": "record-key",
        "type": "string"
      }
    },
    "required": [
      "repo",
      "collection",
      "rkey"
    ],
    "type": "params"
  },
  "type": "query"
}