Skip to main content

CodexInfo

Admin-only presence object embedded on a series. Absent (the codex field is None) when the series is not on Codex or the caller is not an admin.

deepLinkstringrequired

Deep link to the series page in Codex's web UI.

linkKindCodexLinkKind (string)required

How a link was established.

Possible values: [auto, manual]

localMaxChapternumber,null<double>nullable

Highest owned chapter on Codex (comparison basis).

localMaxVolumenumber,null<double>nullable

Highest owned volume on Codex (comparison basis).

seriesUuidstringrequired
statusCodexStatus (string)required

Presence status for a series the operator owns on Codex.

Possible values: [complete, behind, present]

syncedAtinteger<int64>required

When this link was last written by a sweep.

volumesOwnedinteger,null<int64>nullable

Approximate count of owned volumes (display-only; never compared).

CodexInfo
{
"deepLink": "string",
"linkKind": "auto",
"localMaxChapter": 0,
"localMaxVolume": 0,
"seriesUuid": "string",
"status": "complete",
"syncedAt": 0,
"volumesOwned": 0
}