# town.delve.graph.getList

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.graph.getList)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.graph.getList/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.graph.getList/examples)

## Definitions

### `town.delve.graph.getList`

**Type**: `query`

Gets a 'view' (with additional context) of a specified list.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `list` | `string` (at-uri) | Yes | Reference (AT-URI) of the list record to hydrate. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `items` | `array` | Yes |  |
| `list` | `ref` → `town.delve.graph.defs#listView` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Gets a 'view' (with additional context) of a specified list.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "items": {
              "items": {
                "ref": "town.delve.graph.defs#listItemView",
                "type": "ref"
              },
              "type": "array"
            },
            "list": {
              "ref": "town.delve.graph.defs#listView",
              "type": "ref"
            }
          },
          "required": [
            "list",
            "items"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "list": {
            "description": "Reference (AT-URI) of the list record to hydrate.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "list"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.delve.graph.getList",
  "lexicon": 1
}
```
