# net.atpix.gallery.getAlbum

> 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.getAlbum)
- [Documentation](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.getAlbum/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.getAlbum/examples)

## Definitions

### `net.atpix.gallery.getAlbum`

**Type**: `query`

Get a single album; permissioned albums require space credentials.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `hydrateItems` | `boolean` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `album` | `ref` → `net.atpix.gallery.defs#albumView` | Yes |  |
| `items` | `array` | No |  |

## Raw Schema

```json
{
  "id": "net.atpix.gallery.getAlbum",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "album"
          ],
          "properties": {
            "album": {
              "ref": "net.atpix.gallery.defs#albumView",
              "type": "ref"
            },
            "items": {
              "type": "array",
              "items": {
                "ref": "net.atpix.gallery.defs#photoView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string",
            "format": "at-uri"
          },
          "hydrateItems": {
            "type": "boolean",
            "default": false
          }
        }
      },
      "description": "Get a single album; permissioned albums require space credentials."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "target_collection": "net.atpix.gallery.album"
}
```