CollectionListResponse

List of collections.

items object[]required

Array [

automaticbooleanrequired

true when membership comes from condition instead of a hand-picked list. Derived from condition, never stored separately.

Example: false

conditionobject | nullnullable

The rule defining membership, or null for a hand-picked collection.

Returned as the raw stored JSON rather than a parsed condition so that a collection whose rule somehow became invalid still round-trips to the UI, where an administrator can see and correct it. Writes go through the typed SeriesCondition, so a rule that cannot be parsed cannot be saved in the first place.

createdAtstring<date-time>required

idstring<uuid>required

Example: 550e8400-e29b-41d4-a716-446655440000

namestringrequired

Example: Batman

orderedbooleanrequired

Default presentation order when no sort is requested: manual when true, title otherwise.

Example: false

seriesCountinteger,null<int64>nullable

Number of member series visible to the requesting user.

null for an automatic collection. Counting one means resolving its whole rule, so a list endpoint that reported it would run every rule on the server to render a single page. Clients that need the number for an automatic collection get it from the member list they already fetch.

Possible values: >= 0

Example: 12

summarystring | nullnullable

Optional description.

Example: The Dark Knight's essential arcs.

updatedAtstring<date-time>required

]

totalintegerrequired

Possible values: >= 0

Example: 3

CollectionListResponse

{
  "items": [
    {
      "automatic": false,
      "condition": "Unknown Type: object,null",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Batman",
      "ordered": false,
      "seriesCount": 12,
      "summary": "The Dark Knight's essential arcs.",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "total": 3
}