Skip to main content

ReadListListResponse

List of read lists.

items object[]required
  • Array [
  • bookCountinteger<int64>required

    Number of member books visible to the requesting user.

    Possible values: >= 0

    Example: 24
    createdAtstring<date-time>required
    idstring<uuid>required
    Example: 550e8400-e29b-41d4-a716-446655440000
    namestringrequired
    Example: Civil War
    orderedbooleanrequired

    When true, members are kept in manual reading order; otherwise sorted by release date.

    Example: true
    summarystring | nullnullable

    Optional description (Komga read lists carry a summary).

    updatedAtstring<date-time>required
  • ]
  • totalintegerrequired

    Possible values: >= 0

    Example: 3
    ReadListListResponse
    {
    "items": [
    {
    "bookCount": 24,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Civil War",
    "ordered": true,
    "summary": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "total": 3
    }