library-graphql

Query.books

GRAPHQLQuery.books

List books matching filter, paginated by page, ordered by id. Omitting filter and page returns the full catalog, one page at a time.

Parameters

NameInTypeRequiredDescription
filterargumentBookFilterCriteria narrowing the result set; omit to match every book.
pageargumentPageInputPagination window over the filtered results; omit for the first, unbounded page.

Responses

result BookPage!

FieldTypeRequiredDescription
books[Book!]!yesThe books on this page.
authorAuthor!yesThe author who wrote this book.
bioString!yesA short biography of the author.
books[Book!]!yesThe books this author has written.
idID!yesUnique identifier assigned by the server, prefixed with au_.
nameString!yesThe author's full name.
authorIdID!yesThe id of the Author who wrote this book.
createdAtTime!yesWhen the book record was created.
currentLoanLoanThe open loan currently holding this book, or null if it is available.
bookBook!yesThe borrowed book.
bookIdID!yesThe id of the borrowed Book.
borrowedAtTime!yesWhen the loan started.
dueAtTime!yesWhen the book is expected back.
idID!yesUnique identifier assigned by the server, prefixed with ln_.
overdueBoolean!yesComputed at query time: true if the loan is still open and past its dueAt. Never stored, so it never goes stale.
returnedAtTimeWhen the book was actually returned, or null while the loan is still open.
userUser!yesThe user who borrowed the book.
userIdID!yesThe id of the User who borrowed the book.
idID!yesUnique identifier assigned by the server, prefixed with bk_.
isbnString!yesThe book's ISBN. Must be unique across the catalog.
publishedYearInt!yesThe year the book was first published. Must be between 1450 and next year.
statusBookStatus!yesThe book's current availability.
titleString!yesThe book's display title, 1-200 characters.
updatedAtTime!yesWhen the book record was last modified.
totalInt!yesTotal number of matches before offset/limit was applied.