Skip to content

AlbumCollectionResponseDto

Endpoints · All schemas

FieldRequiredDescription
albumCountYesNumber of albums inside the collection
albumsYesAlbums inside the collection, in display order
assetCountYesItems in the collection and its albums (sum, not deduplicated)
collectionYesSee definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AlbumResponseDto

{
  "properties": {
    "albumCount": {
      "description": "Number of albums inside the collection",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "albums": {
      "description": "Albums inside the collection, in display order",
      "items": {
        "$ref": "#/components/schemas/AlbumResponseDto"
      },
      "type": "array"
    },
    "assetCount": {
      "description": "Items in the collection and its albums (sum, not deduplicated)",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "collection": {
      "$ref": "#/components/schemas/AlbumResponseDto"
    }
  },
  "required": [
    "albumCount",
    "albums",
    "assetCount",
    "collection"
  ],
  "type": "object"
}