# ink.resenha.book.getReaders

> Signed in, also which readers the caller follows have it.

- Kind: query
- Authority: book.resenha.ink
- Lexicon: 1
- Published by [resenha.ink](https://lexicon.garden/identity/did:plc:v7itjf4h3sb5zuegiiskctqb), not the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.book.getReaders)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.book.getReaders/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.book.getReaders/analytics)

## Query (`ink.resenha.book.getReaders`)

Type: query · GET

### Parameters (query string)

- `hiveId` (string, required)
  - Constraints: maxLength: 64
- `scope` (string): all: every book reader the server knows, on BookHive, Popfeed and Resenha. resenha: Resenha's readers only.
  - Constraints: default: "all", knownValues: all | resenha

### Output (application/json)

- `following` (array)
  - `items` (ref)
    - Reference: `#followedReader`
- `read` (integer, required)
  - Constraints: minimum: 0
- `reading` (integer, required)
  - Constraints: minimum: 0
- `wantToRead` (integer, required)
  - Constraints: minimum: 0

## #followedReader (`ink.resenha.book.getReaders#followedReader`)

Type: object

### Properties

- `did` (string · did, required)
- `status` (string, required)
  - Constraints: knownValues: wantToRead | reading | read | abandoned

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "followedReader": {
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        },
        "status": {
          "knownValues": [
            "wantToRead",
            "reading",
            "read",
            "abandoned"
          ],
          "type": "string"
        }
      },
      "required": [
        "did",
        "status"
      ],
      "type": "object"
    },
    "main": {
      "description": "Signed in, also which readers the caller follows have it.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "following": {
              "items": {
                "ref": "#followedReader",
                "type": "ref"
              },
              "type": "array"
            },
            "read": {
              "minimum": 0,
              "type": "integer"
            },
            "reading": {
              "minimum": 0,
              "type": "integer"
            },
            "wantToRead": {
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "wantToRead",
            "reading",
            "read"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "hiveId": {
            "maxLength": 64,
            "type": "string"
          },
          "scope": {
            "default": "all",
            "description": "all: every book reader the server knows, on BookHive, Popfeed and Resenha. resenha: Resenha's readers only.",
            "knownValues": [
              "all",
              "resenha"
            ],
            "type": "string"
          }
        },
        "required": [
          "hiveId"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "How many readers have a book, by status.",
  "id": "ink.resenha.book.getReaders",
  "lexicon": 1
}
```