Bookshelves.volumes: list

Page Summary

This API retrieves volumes from a specific bookshelf for a given user.
The request uses the GET HTTP method and requires the shelf and userId parameters.
Optional parameters include maxResults , showPreorders , source , and startIndex .
A successful response returns the resource type, total number of volumes, and a list of volumes.

Retrieves volumes in a specific bookshelf for the specified user. Try it now .

GET https://www.googleapis.com/books/v1/users/ userId 
/bookshelves/ shelf 
/volumes

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)

Do not supply a request body with this method.

If successful, this method returns a response body with the following structure:

{  
 "kind" 
 : 
  
 "books#volumes" 
 , 
  
 "totalItems" 
 : 
  
  integer 
 
 , 
  
 "items" 
 : 
  
 [ 
  
  volumes 
  
 Resource 
 
  
 ] 
}

Property Name	Value	Description
`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.

Use the explorer below to call this method on live data and see the response.