# zone.stratos.sync.listRecordPaths

> Published by [lexicon.northsky.app](https://lexicon.garden/identity/did:plc:6uxgo3ypovauub7nblwylqyv)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:6uxgo3ypovauub7nblwylqyv/zone.stratos.sync.listRecordPaths)
- [Documentation](https://lexicon.garden/lexicon/did:plc:6uxgo3ypovauub7nblwylqyv/zone.stratos.sync.listRecordPaths/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:6uxgo3ypovauub7nblwylqyv/zone.stratos.sync.listRecordPaths/examples)

## Definitions

### `zone.stratos.sync.listRecordPaths`

**Type**: `query`

Full-state recovery: enumerate a repo's record paths and their current CIDs, mirroring listRecords semantics. Record values are inlined by default; excludeValues returns metadata only. Boundary-gated: the caller only observes records within its enrolled boundaries. Intended as the fallback when the oplog (listRepoOps) returns OplogTruncated: the caller enumerates paths, diffs locally, and fetches misses. Callers must authenticate with a signed service JWT via the Authorization: Bearer header.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | The DID of the repo to enumerate. |
| `limit` | `integer` | No | Maximum number of rows to return in this page. |
| `cursor` | `string` | No | Opaque pagination cursor from a previous response. |
| `collection` | `string` (nsid) | No | Optional single collection to enumerate. When omitted, all collections are enumerated. |
| `excludeValues` | `boolean` | No | When true, record values are omitted and only path metadata is returned. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Opaque pagination cursor to fetch the next page. Absent when enumeration is complete. |
| `records` | `array` | Yes | The record paths in this page. |

#### Errors

- **RepoNotFound**: The requested repo does not exist.
- **AuthRequired**: Service authentication is required.

### `zone.stratos.sync.listRecordPaths#recordPath`

**Type**: `object`

A record path with its current CID and optionally its value.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes | The CID (string form) of the current record value. |
| `rkey` | `string` | Yes | The record key. |
| `value` | `unknown` | No | The current record value, inlined by default. Omitted when excludeValues is true. |
| `collection` | `string` (nsid) | Yes | The record collection. |

## Raw Schema

```json
{
  "id": "zone.stratos.sync.listRecordPaths",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "RepoNotFound",
          "description": "The requested repo does not exist."
        },
        {
          "name": "AuthRequired",
          "description": "Service authentication is required."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "records"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Opaque pagination cursor to fetch the next page. Absent when enumeration is complete."
            },
            "records": {
              "type": "array",
              "items": {
                "ref": "#recordPath",
                "type": "ref"
              },
              "description": "The record paths in this page."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "format": "did",
            "description": "The DID of the repo to enumerate."
          },
          "limit": {
            "type": "integer",
            "default": 100,
            "maximum": 1000,
            "minimum": 1,
            "description": "Maximum number of rows to return in this page."
          },
          "cursor": {
            "type": "string",
            "description": "Opaque pagination cursor from a previous response."
          },
          "collection": {
            "type": "string",
            "format": "nsid",
            "description": "Optional single collection to enumerate. When omitted, all collections are enumerated."
          },
          "excludeValues": {
            "type": "boolean",
            "default": false,
            "description": "When true, record values are omitted and only path metadata is returned."
          }
        }
      },
      "description": "Full-state recovery: enumerate a repo's record paths and their current CIDs, mirroring listRecords semantics. Record values are inlined by default; excludeValues returns metadata only. Boundary-gated: the caller only observes records within its enrolled boundaries. Intended as the fallback when the oplog (listRepoOps) returns OplogTruncated: the caller enumerates paths, diffs locally, and fetches misses. Callers must authenticate with a signed service JWT via the Authorization: Bearer header."
    },
    "recordPath": {
      "type": "object",
      "required": [
        "collection",
        "rkey",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "The CID (string form) of the current record value."
        },
        "rkey": {
          "type": "string",
          "maxLength": 512,
          "description": "The record key."
        },
        "value": {
          "type": "unknown",
          "description": "The current record value, inlined by default. Omitted when excludeValues is true."
        },
        "collection": {
          "type": "string",
          "format": "nsid",
          "description": "The record collection."
        }
      },
      "description": "A record path with its current CID and optionally its value."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```