---
title: "Retrieve a ZIN Volume details"
method: GET
path: "/dcd/zin_volume/{id_or_slug}"
tags: ["dcd-video"]
---

# Retrieve a ZIN Volume details

`GET /dcd/zin_volume/{id_or_slug}`

Will contain all the ZIN volume information, including the sections, videos, music, notes, etc.

## Path parameters

- `id_or_slug` string, required

## Query parameters

- `type` 'Video' | 'Music'

## Response `200`

ZIN Volume information.

- ZinVolume
  - `id` integer, required
  - `name` string
  - `slug` string
  - `image` string — TBD
  - `description` string
  - `legal_description` string — Usually contains information about the licensing and when the user can use on their classes.
  - `sections` object — Sections of the on volume
    - `one-on-one` VideoSection
      - `name` string, required
      - `videos` Video[], required
        - `id` integer
        - `name` string
        - `description` string
        - `duration` integer — Time in seconds.
        - `thumbnail_url` string
        - `keywords` string[]
        - `rhythm` Rhythm
          - `id` integer, required
          - `name` string, required
          - `version` integer — The version of the returned entity
        - `categories` VideoCategory[] — Video categories without the children categories.
          - `id` integer, required
          - `thumbnail_url` string, required
          - `image` string, required
          - `name` string, required
          - `description` string
          - `legal_description` string
          - `type` 'regular' | 'zin-volume', required
          - `display_order` integer
          - `generated_name` string — Name generated from the slug. Used on the search functionality.
          - `prefix` CategoryPrefix[]
            - `label` string, required — Can be null
            - `color` CategoryPrefixColor, required — Media category prefix color
              - …
          - `children_categories` MusicCategory[]
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `slug` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'mega-mix' | 'zin-volume', required
            - `display_order` integer
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
            - `num_music` integer
            - `version` integer — The version of the returned entity
          - `num_videos` integer
          - `version` integer — The version of the returned entity
        - `can_stream` boolean
        - `can_download` boolean
        - `release_date` integer — Music release date as unix timestamp
        - `is_spicy` boolean
        - `is_favorite` boolean
        - `play_count` integer — How many times the video has been played
        - `related_music` Music
          - `id` integer, required
          - `name` string, required
          - `duration` integer, required — Time in seconds.
          - `keywords` string[]
          - `bpm` integer — Beats Per Minute.
          - `rhythm` Rhythm, required
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `artist` Artist, required
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `categories` MusicCategory[] — Music categories without the children categories.
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `slug` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'mega-mix' | 'zin-volume', required
            - `display_order` integer
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
            - `num_music` integer
            - `version` integer — The version of the returned entity
          - `chapters` ChapterList[] — Music chapters.
            - Chapter[] — List of chapters.
              - …
          - `can_stream` boolean, required
          - `can_download` boolean, required
          - `release_date` integer — Music release date as unix timestamp
          - `is_spicy` boolean
          - `is_favorite` boolean
          - `has_choreo_steps` boolean
          - `external_id` string — The external music id
          - `special_notes` string — Legal or special notes for music. This field is optional and might not be present in the output
          - `related_videos` Video[]
          - `choreography_video` Video — recursive
          - `version` integer — The version of the returned entity
        - `external_assets` ExternalAsset[]
          - `url` string
          - `width` integer
          - `height` integer
          - `file_size` string
          - `content_type` string
          - `type` string
        - `choreo_notes` string
        - `m3u8` string
        - `version` integer — The version of the returned entity
      - `version` integer — The version of the returned entity
    - `live-class` VideoSection
      - `name` string, required
      - `videos` Video[], required
        - `id` integer
        - `name` string
        - `description` string
        - `duration` integer — Time in seconds.
        - `thumbnail_url` string
        - `keywords` string[]
        - `rhythm` Rhythm
          - `id` integer, required
          - `name` string, required
          - `version` integer — The version of the returned entity
        - `categories` VideoCategory[] — Video categories without the children categories.
          - `id` integer, required
          - `thumbnail_url` string, required
          - `image` string, required
          - `name` string, required
          - `description` string
          - `legal_description` string
          - `type` 'regular' | 'zin-volume', required
          - `display_order` integer
          - `generated_name` string — Name generated from the slug. Used on the search functionality.
          - `prefix` CategoryPrefix[]
            - `label` string, required — Can be null
            - `color` CategoryPrefixColor, required — Media category prefix color
              - …
          - `children_categories` MusicCategory[]
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `slug` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'mega-mix' | 'zin-volume', required
            - `display_order` integer
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
            - `num_music` integer
            - `version` integer — The version of the returned entity
          - `num_videos` integer
          - `version` integer — The version of the returned entity
        - `can_stream` boolean
        - `can_download` boolean
        - `release_date` integer — Music release date as unix timestamp
        - `is_spicy` boolean
        - `is_favorite` boolean
        - `play_count` integer — How many times the video has been played
        - `related_music` Music
          - `id` integer, required
          - `name` string, required
          - `duration` integer, required — Time in seconds.
          - `keywords` string[]
          - `bpm` integer — Beats Per Minute.
          - `rhythm` Rhythm, required
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `artist` Artist, required
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `categories` MusicCategory[] — Music categories without the children categories.
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `slug` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'mega-mix' | 'zin-volume', required
            - `display_order` integer
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
            - `num_music` integer
            - `version` integer — The version of the returned entity
          - `chapters` ChapterList[] — Music chapters.
            - Chapter[] — List of chapters.
              - …
          - `can_stream` boolean, required
          - `can_download` boolean, required
          - `release_date` integer — Music release date as unix timestamp
          - `is_spicy` boolean
          - `is_favorite` boolean
          - `has_choreo_steps` boolean
          - `external_id` string — The external music id
          - `special_notes` string — Legal or special notes for music. This field is optional and might not be present in the output
          - `related_videos` Video[]
          - `choreography_video` Video — recursive
          - `version` integer — The version of the returned entity
        - `external_assets` ExternalAsset[]
          - `url` string
          - `width` integer
          - `height` integer
          - `file_size` string
          - `content_type` string
          - `type` string
        - `choreo_notes` string
        - `m3u8` string
        - `version` integer — The version of the returned entity
      - `version` integer — The version of the returned entity
    - `music` MusicSection
      - `name` string, required
      - `music` Music[], required
        - `id` integer, required
        - `name` string, required
        - `duration` integer, required — Time in seconds.
        - `keywords` string[]
        - `bpm` integer — Beats Per Minute.
        - `rhythm` Rhythm, required
          - `id` integer, required
          - `name` string, required
          - `version` integer — The version of the returned entity
        - `artist` Artist, required
          - `id` integer, required
          - `name` string, required
          - `version` integer — The version of the returned entity
        - `categories` MusicCategory[] — Music categories without the children categories.
          - `id` integer, required
          - `thumbnail_url` string, required
          - `image` string, required
          - `name` string, required
          - `slug` string, required
          - `description` string
          - `legal_description` string
          - `type` 'regular' | 'mega-mix' | 'zin-volume', required
          - `display_order` integer
          - `prefix` CategoryPrefix[]
            - `label` string, required — Can be null
            - `color` CategoryPrefixColor, required — Media category prefix color
              - …
          - `children_categories` MusicCategory[]
          - `num_music` integer
          - `version` integer — The version of the returned entity
        - `chapters` ChapterList[] — Music chapters.
          - Chapter[] — List of chapters.
            - `id` integer, required
            - `title` string, required
            - `position` integer, required
        - `can_stream` boolean, required
        - `can_download` boolean, required
        - `release_date` integer — Music release date as unix timestamp
        - `is_spicy` boolean
        - `is_favorite` boolean
        - `has_choreo_steps` boolean
        - `external_id` string — The external music id
        - `special_notes` string — Legal or special notes for music. This field is optional and might not be present in the output
        - `related_videos` Video[]
          - `id` integer
          - `name` string
          - `description` string
          - `duration` integer — Time in seconds.
          - `thumbnail_url` string
          - `keywords` string[]
          - `rhythm` Rhythm
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `categories` VideoCategory[] — Video categories without the children categories.
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'zin-volume', required
            - `display_order` integer
            - `generated_name` string — Name generated from the slug. Used on the search functionality.
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
              - …
            - `num_videos` integer
            - `version` integer — The version of the returned entity
          - `can_stream` boolean
          - `can_download` boolean
          - `release_date` integer — Music release date as unix timestamp
          - `is_spicy` boolean
          - `is_favorite` boolean
          - `play_count` integer — How many times the video has been played
          - `related_music` Music — recursive
          - `external_assets` ExternalAsset[]
            - `url` string
            - `width` integer
            - `height` integer
            - `file_size` string
            - `content_type` string
            - `type` string
          - `choreo_notes` string
          - `m3u8` string
          - `version` integer — The version of the returned entity
        - `choreography_video` Video
          - `id` integer
          - `name` string
          - `description` string
          - `duration` integer — Time in seconds.
          - `thumbnail_url` string
          - `keywords` string[]
          - `rhythm` Rhythm
            - `id` integer, required
            - `name` string, required
            - `version` integer — The version of the returned entity
          - `categories` VideoCategory[] — Video categories without the children categories.
            - `id` integer, required
            - `thumbnail_url` string, required
            - `image` string, required
            - `name` string, required
            - `description` string
            - `legal_description` string
            - `type` 'regular' | 'zin-volume', required
            - `display_order` integer
            - `generated_name` string — Name generated from the slug. Used on the search functionality.
            - `prefix` CategoryPrefix[]
              - …
            - `children_categories` MusicCategory[]
              - …
            - `num_videos` integer
            - `version` integer — The version of the returned entity
          - `can_stream` boolean
          - `can_download` boolean
          - `release_date` integer — Music release date as unix timestamp
          - `is_spicy` boolean
          - `is_favorite` boolean
          - `play_count` integer — How many times the video has been played
          - `related_music` Music — recursive
          - `external_assets` ExternalAsset[]
            - `url` string
            - `width` integer
            - `height` integer
            - `file_size` string
            - `content_type` string
            - `type` string
          - `choreo_notes` string
          - `m3u8` string
          - `version` integer — The version of the returned entity
        - `version` integer — The version of the returned entity
      - `version` integer — The version of the returned entity
  - `notes` object — Choreo notes
    - `name` string
    - `url` string
    - `locale` string
  - `version` integer — The version of the returned entity

## Other responses

- `304` — If the If-None-Match header is sent and matches with the Etag it will return the 304 (Not Modified) response without the data on the body.

---

[API](https://skmtc.net/zumba/apis/zumba-s-api.md) · [All operations](https://skmtc.net/zumba/apis/zumba-s-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zumba/zumba-s-api/revisions/90e715bcdf3d/schema)