Skip to main content

CollectionListResponse

List of collections.

items object[]required
  • Array [
  • createdAtstring<date-time>required
    idstring<uuid>required
    Example: 550e8400-e29b-41d4-a716-446655440000
    namestringrequired
    Example: Batman
    orderedbooleanrequired

    When true, members are kept in manual order; otherwise sorted by title.

    Example: false
    seriesCountinteger<int64>required

    Number of member series visible to the requesting user.

    Possible values: >= 0

    Example: 12
    updatedAtstring<date-time>required
  • ]
  • totalintegerrequired

    Possible values: >= 0

    Example: 3
    CollectionListResponse
    {
    "items": [
    {
    "createdAt": "2024-07-29T15:51:28.071Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Batman",
    "ordered": false,
    "seriesCount": 12,
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "total": 3
    }