# buzz.bookhive.getList

> Published by [bookhive.buzz](https://lexicon.garden/identity/did:plc:enu2j5xjlqsjaylv3du4myh4)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.getList)
- [Documentation](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.getList/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:enu2j5xjlqsjaylv3du4myh4/buzz.bookhive.getList/examples)

## Definitions

### `buzz.bookhive.getList`

**Type**: `query`

Get a book list with its items and hydrated book metadata.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` | Yes | AT-URI of the list |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `list` | `ref` → `#listView` | Yes |  |
| `items` | `array` | Yes |  |

### `buzz.bookhive.getList#listView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` | Yes |  |
| `uri` | `string` | Yes |  |
| `name` | `string` | Yes |  |
| `tags` | `array` | No |  |
| `ordered` | `boolean` | No |  |
| `userDid` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `itemCount` | `integer` | No |  |
| `userHandle` | `string` | No |  |
| `description` | `string` | No |  |

### `buzz.bookhive.getList#listItemView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` | Yes |  |
| `cover` | `string` | No |  |
| `title` | `string` | No |  |
| `hiveId` | `string` | No |  |
| `rating` | `integer` | No |  |
| `addedAt` | `string` (datetime) | Yes |  |
| `authors` | `string` | No |  |
| `position` | `integer` | No |  |
| `thumbnail` | `string` | No |  |
| `description` | `string` | No |  |

## Raw Schema

```json
{
  "id": "buzz.bookhive.getList",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "list",
            "items"
          ],
          "properties": {
            "list": {
              "ref": "#listView",
              "type": "ref"
            },
            "items": {
              "type": "array",
              "items": {
                "ref": "#listItemView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string",
            "description": "AT-URI of the list"
          }
        }
      },
      "description": "Get a book list with its items and hydrated book metadata."
    },
    "listView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "userDid",
        "name",
        "createdAt"
      ],
      "properties": {
        "cid": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ordered": {
          "type": "boolean"
        },
        "userDid": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "itemCount": {
          "type": "integer"
        },
        "userHandle": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    },
    "listItemView": {
      "type": "object",
      "required": [
        "uri",
        "addedAt"
      ],
      "properties": {
        "uri": {
          "type": "string"
        },
        "cover": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "hiveId": {
          "type": "string"
        },
        "rating": {
          "type": "integer"
        },
        "addedAt": {
          "type": "string",
          "format": "datetime"
        },
        "authors": {
          "type": "string"
        },
        "position": {
          "type": "integer"
        },
        "thumbnail": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```