---
title: "ListShelves"
method: GET
path: "/v1/shelves"
tags: ["LibraryService"]
---

# ListShelves

`GET /v1/shelves`

Lists shelves. The order is unspecified but deterministic. Newly created
 shelves will not necessarily be added to the end of this list.

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

OK

- ListShelvesResponse — Response message for LibraryService.ListShelves.
  - `shelves` Shelf[] — The list of shelves.
    - `name` string, required — The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.
    - `theme` string — The theme of the shelf
    - `next_sort_at` string, date — The next sorting date.
    - `created_at` string, date-time — The creation date and time.
    - `updated_at` string, date-time — The last update date and time.
  - `next_page_token` string — A token to retrieve next page of results. Pass this value in the [ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token] field in the subsequent call to `ListShelves` method to retrieve the next page of results.

## Other responses

- `default` — Default error response

## Changes

- **2022-04-11** (v1) `ac9d37cae0e0` — 2 breaking
  - the response's body type changed from no type to `object` for status `200`
  - the `shelves/items/` response's property type changed from no type to `object` for status `200`
- **2022-02-23** (v1) `639a4ec995ca` — 1 info
  - the response property `shelves/items/name` became required for the status `200`
- **2022-01-12** (v1) `00e696b6b84a` — 1 info
  - the `shelves/items/name` response's property pattern `^shelves/[a-z2-7]{26}$` was added for the status `200`
- **2022-01-11** (v1) `26b3bc7b5169` — 1 breaking
  - for the `query` request parameter `page_size`, the type changed from `string` to `integer`, and format from no format to `int32`
- **2022-01-11** (v1) `2a0f5e3b8734` — 1 info
  - api operation id `ListShelves` removed and replaced with `LibraryService_ListShelves`

[Full history](https://skmtc.dev/kollalabs/apis/libraryservice-api/changes/v1/shelves/get.md)

---

[API](https://skmtc.dev/kollalabs/apis/libraryservice-api.md) · [All operations](https://skmtc.dev/kollalabs/apis/libraryservice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kollalabs/libraryservice-api/revisions/b3518c94ac37/schema)