v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135137125.7 KB
mylibrary

Retrieves a list of annotations, possibly filtered.

get/books/v1/mylibrary/annotations

Query parameters

contentVersionstring

The content version for the requested volume.

layerIdstring

The layer ID to limit annotation by.

layerIdsstring[]

The layer ID(s) to limit annotation by.

maxResultsinteger

Maximum number of results to return

pageTokenstring

The value of the nextToken from the previous page.

showDeletedboolean

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

sourcestring

String to identify the originator of this request.

updatedMaxstring

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

updatedMinstring

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

volumeIdstring

The volume to restrict annotations to.

Response

Successful response