Skip to main content
Metadata lookup functions return arrays or paginated data. Query parameters are flat generated parameters, and the client is passed in the second options object when parameters are present.

Genres

Filter by library or collection with the generated library_id and collection_id keys:

Filter-key reference

Use the generated names exactly as shown below. The underscore names mirror the wire query keys; library_id is an array, while collection_id, series_id, and readlist_id are single IDs: Pass page, size, sort, and optionally unpaged only to getAuthors; the other lookup operations return arrays. Do not translate these names to camelCase (libraryId or collectionId)—those keys are not part of the generated signatures.

Tags

The tag endpoints use the same flat filter style, with endpoint-specific keys:
getBookTags also accepts series_id and readlist_id. getTags accepts collection_id; getSeriesTags accepts collection_id.

Authors

List authors with optional search, role, scope, and pagination parameters:
For autocomplete, use getAuthorsNames({ search }, { client }); it returns string[]:

Publishers, languages, ratings, and sharing labels

These endpoints return arrays of strings. getPublishers, getLanguages, getAgeRatings, and getSharingLabels accept library_id?: string[] and collection_id?: string:
Languages use ISO 639-1 codes such as en, ja, and fr.

Build filter options

Fetch independent lists in parallel and keep each generated result separate so errors remain attributable:

Autocomplete and library summaries

For an autocomplete field, query getAuthorsNames rather than loading a full author page. Debounce keystrokes in the UI and avoid sending empty searches:
You can also build a lightweight metadata summary for an administration view. The lookup arrays are complete for the selected scope; authors remain paginated, so use totalElements rather than content.length for the count:
If one request fails, inspect that result’s error and response instead of silently treating every list as empty. Parallel requests improve latency, but they do not make a partial response a successful metadata snapshot.

Error handling

The default result exposes typed generated errors and the native response. Use the status for transport-level decisions:

Next steps

Series

Filter and search series using metadata.

Books

Search books by author, genre, and more.

Collections

Organize content into collections.

Users

Configure content restrictions with labels.