Bookshelves.volumes: list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves volumes in a specific bookshelf for the specified user.
Try it now.
Request
HTTP Request
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
Parameters
| Parameter Name |
Value |
Description |
| Required Parameters |
shelf |
string |
ID of bookshelf to retrieve volumes.
|
userId |
string |
ID of user for whom to retrieve bookshelf volumes.
|
| Optional Parameters |
maxResults |
unsigned integer |
Maximum number of results to return
|
showPreorders |
boolean |
Set to true to show pre-ordered books. Defaults to false.
|
source |
string |
String to identify the originator of this request.
|
startIndex |
unsigned integer |
Index of the first element to return (starts at 0)
|
Request Body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
| Property Name |
Value |
Description |
Notes |
kind |
string |
Resource type. |
|
totalItems |
integer |
Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. |
|
items[] |
list |
A list of volumes. |
|
Try It!
Use the explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[null,null,["Last updated 2024-06-26 UTC."],[[["\u003cp\u003eRetrieves a list of books from a specific bookshelf belonging to a given user.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parameters such as maximum results, pre-orders, and starting index for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the total number of books found and a list of book details.\u003c/p\u003e\n"],["\u003cp\u003eYou can interactively try this method using the provided explorer to test it with live data.\u003c/p\u003e\n"]]],[],null,["# Bookshelves.volumes: list\n\nRetrieves volumes in a specific bookshelf for the specified user.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|-----------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | ID of bookshelf to retrieve volumes. |\n| `userId` | `string` | ID of user for whom to retrieve bookshelf volumes. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\n| `showPreorders` | `boolean` | Set to true to show pre-ordered books. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first element to return (starts at 0) |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"books#volumes\",\n \"totalItems\": integer,\n \"items\": [\n volumes Resource\n ]\n}\n```\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `totalItems` | `integer` | Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. | |\n| `items[]` | `list` | A list of volumes. | |\n\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]