Komga icon

Komga

Interact with the Komga API

Readlist → List

AI-generated

Summary

List readlist items from Komga

Inputs

  • limit — Max number of results to return in a single response; defaults to 50 if not set; range 1–1000 when provided via UI
  • returnAll — Whether to ignore the limit and return all results; when true sets query size to 1000, otherwise uses the limit value
  • search — Search term to filter readlist items
  • libraryId — Filter readlist items by one or more library IDs; accepts multiple values
  • unpaged — When true, returns all results without pagination; overrides limit and returnAll behavior
  • requestOptions — Node-level request configuration including batching, SSL certification, proxy, and timeout settings

Output shape

Array of readlist items retrieved from the Komga API, paginated or fully based on query parameters

Pagination is handled by the node; when unpaged is false and returnAll is false, results are capped by limit. When returnAll is true, up to 1000 items are returned per request.

Examples

Example 1: Fetch up to 20 readlist items

limit=20, returnAll=false

Example 2: Retrieve all readlist items without pagination limit

unpaged=true

Discussion