# net.atpix.gallery.listAlbumItems

> Published by [lexicon.atpix.net](https://lexicon.garden/identity/did:plc:x4crpdfko2d7xrcd5eovpwex)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.listAlbumItems)
- [Documentation](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.listAlbumItems/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.listAlbumItems/examples)

## Definitions

### `net.atpix.gallery.listAlbumItems`

**Type**: `query`

List ordered albumItem records for an album.

#### Parameters

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

#### Output

**Encoding**: `application/json`

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

## Raw Schema

```json
{
  "id": "net.atpix.gallery.listAlbumItems",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "items"
          ],
          "properties": {
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "uri",
                  "albumUri",
                  "photoUri",
                  "createdAt"
                ],
                "properties": {
                  "uri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "photo": {
                    "ref": "net.atpix.gallery.defs#photoView",
                    "type": "ref"
                  },
                  "addedBy": {
                    "type": "string",
                    "format": "did"
                  },
                  "albumUri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "photoUri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "position": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "datetime"
                  }
                }
              }
            },
            "cursor": {
              "type": "string"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "albumUri"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 20,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string"
          },
          "albumUri": {
            "type": "string",
            "format": "at-uri"
          }
        }
      },
      "description": "List ordered albumItem records for an album."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```