---
title: "Book list"
method: GET
path: "/v1/books"
tags: ["Book Queries"]
---

# Book list

`GET /v1/books`

Retrieve a list of all <<glossary:Book>>s available to the current user.

---

> 📘
> - By default results are ordered by <<glossary:Book>> PK in descending order but you can alter how and what books are returned by providing different parameters with your request.
> - Use the `name` query parameter to find a <<glossary:Book>> by an exact name. This will be faster than `search` which uses approximate string matching algorithm.

## Query parameters

- `limit` integer
- `offset` integer
- `order` 'ASC' | 'DESC'
- `order_by` 'created' | 'name' | 'pk'
- `name` string
- `search` string
- `xid` string

## Response `200`

Success

- object
  - `status` number — A numerical code that indicates the status of the request.
  - `response` object[] — An array containing objects of <<glossary:Book>>s.
    - `name` string — The name of the <<glossary:Book>>.
    - `created` string, date-time — The date and time when the <<glossary:Book>> was created.
    - `created_ts` string, date-time — The timestamp at which <<glossary:Book>> was created.
    - `pk` integer — Unique identifier key (primary key) of the <<glossary:Book>>.
    - `owner_email` string — The email address of the <<glossary:Book>> owner.
    - `is_public` boolean — Indicates if the <<glossary:Book>> is public or not.
    - `book_uuid` string — A universally unique identification code (uuid) of the <<glossary:Book>>.
    - `id` number — The unique ID of the <<glossary:Book>>.
    - `xid` string — A free form field that can be used to associate a Book with some identity outside of Ocrolus.
    - `book_type` string — Determines what type of processing the Book will go through. Options include DEFAULT, OPTIMA, or WIDGET.
  - `message` string — A textual description that indicates details about this response's status.

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)