# org.passingreads.book.listBookKeys

> Published by [passingreads.org](https://lexicon.garden/identity/did:plc:oeipalbxet5jghoqe6b6ctu6)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.listBookKeys)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.listBookKeys/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.listBookKeys/examples)

## Definitions

### `org.passingreads.book.listBookKeys`

**Type**: `query`

List the book private keys the authenticated user has stashed on the appview. Used by clients to populate the local key cache after sign-in on a new device.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `keys` | `array` | Yes |  |

#### Errors

- **ProfileNotFound**: The authenticated DID has no PassingReads profile indexed by the appview.

## Raw Schema

```json
{
  "id": "org.passingreads.book.listBookKeys",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "ProfileNotFound",
          "description": "The authenticated DID has no PassingReads profile indexed by the appview."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "keys"
          ],
          "properties": {
            "keys": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "bookId",
                  "privateKey",
                  "stashedAt"
                ],
                "properties": {
                  "bookId": {
                    "type": "string"
                  },
                  "stashedAt": {
                    "type": "string",
                    "format": "datetime"
                  },
                  "privateKey": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "List the book private keys the authenticated user has stashed on the appview. Used by clients to populate the local key cache after sign-in on a new device."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```