---
title: "Check queued books"
method: GET
path: "/api/books/availability"
tags: ["books"]
---

# Check queued books

`GET /api/books/availability`

## Request

- Base URL: `https://leafle.org` (the document declares no server; this is the origin it was published from)
- URL: `https://leafle.org/api/books/availability`
- Auth: HTTP bearer

**Access: read token.**

Returns library, digital and purchase links for queued books. `unknown` means a check failed or has not run; `checked_at` is null then. Results use a shared cache. `capped` indicates some books exceeded the request's checking budget.

## Query parameters

- `reader_id` integer, nullable

## Response `200`

Successful Response

- QueueAvailability: GET/POST /api/books/availability: routes for the to-read queue. ``borrower`` is service connectivity (the profile's library resolves to a live connector), not borrowing history; when false, ``books`` carry only search/buy links. ``capped`` is true when the queue was longer than the per-request check budget — the missing tail is unknown, not unavailable.
  - `borrower` boolean, required
  - `digital` boolean, required
  - `acquisition_preference` 'borrow' | 'buy', required
  - `capped` boolean, required
  - `books` QueueBookAvailability[], required
    - `book_id` integer, required
    - `status` 'available' | 'on_loan' | 'held' | 'unavailable' | 'unknown', required
    - `branch` string, nullable, required
    - `was_borrowable` boolean, nullable, required
    - `was_borrowable_on` string, nullable, required
    - `link` string, nullable, required
    - `libby_url` string, nullable, required
    - `buy_url` string, nullable, required
    - `review_url` string, nullable, required
    - `checked_at` integer, nullable, required

## Other responses

- `401`: Missing or unusable credential.
- `403`: Insufficient token scope or the reader is outside your account.
- `422`: Validation Error

---

[API](https://skmtc.dev/leafle/apis/leafle-api.md) · [All operations](https://skmtc.dev/leafle/apis/leafle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/leafle/apis/leafle-api/revisions/f2e56cb74495?raw)