Skip to main content

ReadHistoryResponse

A book's or series' completion history for the requesting user.

Independent of current reading progress: clearing history leaves progress alone, and marking something unread leaves history alone.

entries object[]required

The individual completions, newest first.

  • Array [
  • completedAtstring<date-time>required

    When this pass finished.

    Example: 2024-01-14T20:05:00Z
    startedAtstring<date-time>required

    When this pass started.

    Example: 2024-01-10T14:30:00Z
  • ]
  • lastCompletedAtstring,null<date-time>nullable

    When it was most recently completed, or null if never.

    Example: 2024-01-14T20:05:00Z
    readCountinteger<int64>required

    How many times this has been completed.

    For a series this is the minimum across its books: the series has been read N times only once every volume has. A series with no books reports 0.

    Example: 2
    ReadHistoryResponse
    {
    "entries": [
    {
    "completedAt": "2024-01-14T20:05:00Z",
    "startedAt": "2024-01-10T14:30:00Z"
    }
    ],
    "lastCompletedAt": "2024-01-14T20:05:00Z",
    "readCount": 2
    }