# systems.timker.hawlt.listNotes

> Published by [timker.systems](https://lexicon.garden/identity/did:plc:bazrmgio5a7x53v3pwpqnfds)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:bazrmgio5a7x53v3pwpqnfds/systems.timker.hawlt.listNotes)
- [Documentation](https://lexicon.garden/lexicon/did:plc:bazrmgio5a7x53v3pwpqnfds/systems.timker.hawlt.listNotes/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:bazrmgio5a7x53v3pwpqnfds/systems.timker.hawlt.listNotes/examples)

## Definitions

### `systems.timker.hawlt.listNotes`

**Type**: `query`

List note records from a repo, with optional pagination.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `repo` | `string` (at-identifier) | Yes |  |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `notes` | `array` | Yes |  |
| `cursor` | `string` | No |  |

### `systems.timker.hawlt.listNotes#noteView`

**Type**: `object`

A note record with its AT URI, CID, and server-side index timestamp.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `ref` → `systems.timker.hawlt.note` | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |

## Raw Schema

```json
{
  "id": "systems.timker.hawlt.listNotes",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "notes"
          ],
          "properties": {
            "notes": {
              "type": "array",
              "items": {
                "ref": "#noteView",
                "type": "ref"
              }
            },
            "cursor": {
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "repo"
        ],
        "properties": {
          "repo": {
            "type": "string",
            "format": "at-identifier"
          },
          "limit": {
            "type": "integer",
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string",
            "maxLength": 100
          }
        }
      },
      "description": "List note records from a repo, with optional pagination."
    },
    "noteView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "value",
        "indexedAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "value": {
          "ref": "systems.timker.hawlt.note",
          "type": "ref"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        }
      },
      "description": "A note record with its AT URI, CID, and server-side index timestamp."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```