zone.stratos.space.getRecord

lexicon.northsky.app

Documentation

Get a single record from a permissioned space. Spec-shaped mirror of com.atproto.space.getRecord (atproto#5187): callable with standard user auth (the caller must be a member of the space) or with a space credential for that space (for syncing services). The record must belong to the requested space; records outside it - including records with no space at all - resolve to RecordNotFound (no existence leak).

main query

Get a single record from a permissioned space. Spec-shaped mirror of com.atproto.space.getRecord (atproto#5187): callable with standard user auth (the caller must be a member of the space) or with a space credential for that space (for syncing services). The record must belong to the requested space; records outside it - including records with no space at all - resolve to RecordNotFound (no existence leak).

Parameters

collection string nsid Required

The NSID of the record collection.

repo string did Required

The DID of the account whose repo to read from.

rkey string Required

The Record Key.

space string Required

The space's at:// URI (at://{did}/space/{type}/{skey}). Mirrors the upstream space-ref string format (atproto#5187); declared as a plain string until @atproto/lexicon supports that format. Its space DID must equal this service's DID.

Output

Encodingapplication/json
cid stringcid Required

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 The record does not exist in the requested space (or does not exist at all - indistinguishable by design).
UnknownSpace The requested space URI is malformed or its space DID does not match this service's DID.
AuthRequired The caller is not admitted to the requested space (not a member, or the presented credential targets a different space).
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 DID of the account whose repo to read from.
The Record Key.
The space's at:// URI (at://{did}/space/{type}/{skey}). Mirrors the upstream space-ref string format (atproto#5187); declared as a plain string until @atproto/lexicon supports that format. Its space DID must equal this service's DID.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "RecordNotFound",
      "description": "The record does not exist in the requested space (or does not exist at all - indistinguishable by design)."
    },
    {
      "name": "UnknownSpace",
      "description": "The requested space URI is malformed or its space DID does not match this service's DID."
    },
    {
      "name": "AuthRequired",
      "description": "The caller is not admitted to the requested space (not a member, or the presented credential targets a different space)."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "value"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "value": {
          "type": "unknown"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "space",
      "repo",
      "collection",
      "rkey"
    ],
    "properties": {
      "repo": {
        "type": "string",
        "format": "did",
        "description": "The DID of the account whose repo to read from."
      },
      "rkey": {
        "type": "string",
        "maxLength": 512,
        "description": "The Record Key."
      },
      "space": {
        "type": "string",
        "description": "The space's at:// URI (at://{did}/space/{type}/{skey}). Mirrors the upstream space-ref string format (atproto#5187); declared as a plain string until @atproto/lexicon supports that format. Its space DID must equal this service's DID."
      },
      "collection": {
        "type": "string",
        "format": "nsid",
        "description": "The NSID of the record collection."
      }
    }
  },
  "description": "Get a single record from a permissioned space. Spec-shaped mirror of com.atproto.space.getRecord (atproto#5187): callable with standard user auth (the caller must be a member of the space) or with a space credential for that space (for syncing services). The record must belong to the requested space; records outside it - including records with no space at all - resolve to RecordNotFound (no existence leak)."
}

Lexicon Garden

@