buzz.bookhive.getList

bookhive.buzz

Documentation

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

main query

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

Parameters

uri string Required

AT-URI of the list

Output

Encodingapplication/json
items array Required

No description available.

list ref#listView Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
AT-URI of the list
View raw schema 
{
  "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."
}
listItemView object

No description available.

Properties

addedAt string datetime Required

An RFC 3339 formatted timestamp.

authors string Optional

No description available.

cover string Optional

No description available.

description string Optional

No description available.

hiveId string Optional

No description available.

position integer Optional

No description available.

rating integer Optional

No description available.

thumbnail string Optional

No description available.

title string Optional

No description available.

uri string Required

No description available.

View raw schema 
{
  "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"
    }
  }
}
listView object

No description available.

Properties

cid string Required

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

itemCount integer Optional

No description available.

name string Required

No description available.

ordered boolean Optional

No description available.

tags array of string Optional

No description available.

uri string Required

No description available.

userDid string Required

No description available.

userHandle string Optional

No description available.

View raw schema 
{
  "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"
    }
  }
}

Lexicon Garden

@