I/O Docs: API Documentation

Test our API services using I/O Docs. You can also view our written documentation.

Book data from Penguin Random House

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

App/Key: Manually provide key information

Shared Secret:

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

author

List Methods

Expand Methods

GET listAuthors domains/{domain}/authors

return a list of authors

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
authorId	long	restrict results based on one or more author IDs (see /authors)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
category	string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
onTour	string	only return authors that have a confirmed event in the next 180 days
eventDateFrom	date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
eventDateTo	date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
eventMinPrintScore	int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
hideAuthorsWithNoPhoto	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
authorLastInitial	string	restrict results by one or more last initial facets
showBio	string	only return authors that have bio content
sort	string	(default 'id') one of 'id', 'authorLast' or 'random'
dir	string	(default 'asc') either 'asc' or 'desc'

GET getAuthor domains/{domain}/authors/{authorId}

return details about an author

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
{authorId}	int	restrict by author ID
preferExport	string	when set to true, will cause the items in the works element to prefer titles with the flag 'EXPORT' rather than just picking the frontlistiest
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

GET getAuthorContent domains/{domain}/authors/{authorId}/content

return text about an author

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
{authorId}	int	restrict by author ID
preferExport	string	when set to true, will cause the items in the works element to prefer titles with the flag 'EXPORT' rather than just picking the frontlistiest
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

GET listAuthorEvents domains/{domain}/authors/{authorId}/events

return an author's events

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
state	string	restrict by state
zip	string	restrict by zip code
status	list	restrict by one or more event status
eventDateFrom	date	return events on or after the supplied date
eventDateTo	date	return events on or before the supplied date
sort	string	(default 'id') one of 'id', 'eventdate', 'name', 'title', 'onsale'
dir	string	(default 'asc') either 'asc' or 'desc'
{authorId}	int	restrict by author ID

GET listAuthorRoles domains/{domain}/authors/{authorId}/roles

return an author's roles

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
{authorId}	int	restrict by author ID

GET listAuthorSeries domains/{domain}/authors/{authorId}/series

return an author's series

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
series.countMin	int	restrict series to just those with a minimum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
series.countMax	int	restrict series to just those with a maximum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
series.numbered	string	return numbered series (true) or unnumbered series (false)
series.kids	string	return series that have books with a Children or Young Adult consumer category (true) or don't (false)
series.authorId	list	restrict series matching on the one or two primary authors that we've associated with the series; differs from 'authorId' which would test all the contributors attached to all the ISBN records that have the series code
series.catUri	list	restrict series matching on the one or two primary categories that we've associated with the series; differs from 'catUri' which would test all the categories attached to all the ISBNS records that have the series code
series.minPrintScore	int	restrict series to those where the most recent work's print score is at least a certain threshold
series.ebookOriginal	string	restrict series to those all the ISBN records with that series code have ORIGINAL_ISBN='ORIGINAL' and FORMAT_CODE='EL'
sort	string	(default 'id') one of 'id', 'name', 'seriesDate', 'random'
dir	string	(default 'asc') either 'asc' or 'desc'
{authorId}	int	restrict by author ID

GET listAuthorTitles domains/{domain}/authors/{authorId}/titles

return an author's titles

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	either 'USD' or 'CAD'; only needed if sort=price
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
sort	string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
dir	string	(default 'asc') either 'asc' or 'desc'
{authorId}	int	restrict by author ID

GET listAuthorWebLinks domains/{domain}/authors/{authorId}/weblinks

return an author's web links

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
linkAttr	int	restrict by one or more link attribute values
{authorId}	int	restrict by author ID

GET listAuthorWorks domains/{domain}/authors/{authorId}/works

return an author's works

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
sort	string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
dir	string	(default 'asc') either 'asc' or 'desc'
{authorId}	int	restrict by author ID

GET getViewAuthorListDisplay domains/{domain}/authors/views/list-display

return extended information about a list of authors

Parameter	Type	Description
{domain}	string	restrict by web domain
zoom	string	one or more link rels to be embedded in the response
suppressLinks	string	don't populate the "_links" elements
suppressRecordCount	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
preferLanguage	string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
returnEmptyLists	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
sortPriceTypeCode	string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
start	int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
rows	int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
workId	long	restrict results based on one or more work IDs (see /works)
isbn	long	restrict results based on one or more ISBNs (see /titles)
authorId	long	restrict results based on one or more author IDs (see /authors)
divisionCode	string	restrict results based on one or more division codes (see /divisions)
imprintCode	string	restrict results based on one or more imprint codes (see /imprints)
seriesCode	string	restrict results based on one or more series codes (see /series)
format	string	restrict results based on one or more format codes (see /formats)
formatFamily	string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
eventId	long	restrict results based on one or more event IDs (see /events)
catId	long	restrict results based on one or more category IDs (see /categories)
catUri	string	restrict results based on one or more category alternate identifiers
catSetId	string	restrict category listings (either primary or secondary) to one or more category groups
titleWebLinkAttr	int	results must contain a title weblink entry with one of the specified attrs
authorWebLinkAttr	int	results must contain an author weblink entry with one of the specified attrs
contribRoleCode	string	restrict by one or more contributor role codes (e.g. 'A', '4')
consumerImprint	string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
language	string	restrict results based on one or more language values (e.g. 'E', 'SP')
catSeq	int	restrict results based on the sequencing of the categories assigned to title records
productLine	string	restrict results based on one or more title product line values
productType	string	restrict results based on one or more title product type values
ageRange	string	restrict results based on one or more title age range values (e.g. '0005', '0408')
salesRestriction	string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
saleStatus	string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
subFormat	string	restrict results based on one or more subformat codes (e.g. '001','BE')
subSeries	string	restrict results based on one or more subseries values (e.g. 'The Rift')
propertyName	string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
subtitlePrefix	string	restrict results based on one or more matches against the start of the subtitle
seriesNumber	number	restrict results based on one or more series number values (e.g. 1, 4)
coverColor	string	restrict results based on the color of the cover
ignoreIsbn	long	omit one or more ISBNs or records linked to those titles
ignoreWork	long	omit one or more work IDs or records linked to those works
ignoreAuthor	long	omit one or more author IDs or records linked to those authors
ignoreFormatFamily	string	omit records linked to one or more format families
ignoreFormatCode	string	omit records linked to one or more format codes
ignoreCatUri	string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
ignoreSeries	string	omit records linked to one or more series codes
ignoreContribRole	string	omit records linked to one or more contrib role codes
ignoreSubFormat	string	omit records linked to one or more sub format codes
ignoreProductLine	string	omit records linked to one or more product line codes
ignoreProductType	string	omit records linked to one or more product type codes
ignoreDivisionCode	string	omit records linked to one or more division codes
ignoreSaleStatus	string	omit records linked to one or more sale status codes
ignoreSalesRestriction	string	omit records linked to one or more sales restriction codes
showAwards	string	results must have an awards record
showBestsellers	string	results must have an bestsellers record
showNewReleases	string	results must have an on-sale date between today and 180 days ago
showComingSoon	string	results must have an on-sale date between today and 90 days from now
showPublishedBooks	string	results must have an on-sale date of today or earlier
showCovers	string	titles must have a cover image
showReadingGuides	string	results must have reading guide content
showTeachersGuides	string	results must have teachers guide content
showBoxBundles	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
showFlapCopy	string	restrict results to include or exclude titles that have flap copy content populated
showExcerpt	string	restrict results to include or exclude titles that have an excerpt
showNoTitleBlock	string	restrict results to only include titles that have a NULL 'titleBlock' element
showExportOnly	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
showMovieTieIn	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
showTopselling	string	only applicable to the sales display work view
showFirstReleases	string	restrict results to titles that have the same on-sale date as the work
hasSeriesNumber	string	restrict results to titles that have their series number field populated
minInPrint	long	works must have a LTD in-print across all titles greater than the specified number
minPrintScore	long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
awardMaxSeq	int	restrict results to award winners where the award sequence is less than or equal to the specified value
ageRangeMin	int	restrict results to titles with an age range greater than or equal to the specified value
ageRangeMax	int	restrict results to titles with an age range less than or equal to the specified value
onSaleFrom	date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
onSaleTo	date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
workOnSaleFrom	date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
workOnSaleTo	date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
siteFilter	date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
category	string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
onTour	string	only return authors that have a confirmed event in the next 180 days
eventDateFrom	date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
eventDateTo	date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
eventMinPrintScore	int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
hideAuthorsWithNoPhoto

I/O Docs: API Documentation

Select an Interactive Documentation Enhanced PRH API Resources API v1

author List Methods Expand Methods

author

List Methods

Expand Methods