Sign in
V3 > Mixtape

List mixtapes.

Retrieves a paginated list of mixtapes associated with the provided channel.

get/2/vod/channels/{channel}/mixtapes

Path parameters

channelstring required

Query parameters

colorstring

Mixtape color

Example:#FFCC00
criteriastring nullable

a string free of XSS payloads

Example:"Hello World"
descriptionstring nullable

a string free of XSS payloads

Example:"Hello World"
mixtapesstring nullable

A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

Example:1jhvl2upwoctc,1jhvl2upwoctc,1jhvl2upwoctc
namestring

a string free of XSS payloads

Example:"Hello World"
direction'"asc"' | '"desc"' nullable
key'collected_at' | 'created_at' | 'description' | 'discarded_at' | 'duration' | 'id' | 'name' | 'published' | 'streams' | 'updated_at' | 'validated' required

The key of Mixtape

naturalboolean nullable
reverseboolean nullable
soundexboolean nullable
typestring

The type of {name}<note><strong>standard</strong>: Mixtape default: créée/éditée directement comme une mixtape classique</note><note><strong>generated</strong>: Mixtape produite dynamiquement par une autre application</note><note><strong>composite</strong>: Mixtape qui référence d’autres mixtape</note>

Example:standard
validityinteger

The {name} validity duration (in seconds)

validity_strategystring nullable

The strategy to apply for validity adjustment<note><strong>only_increase</strong>: Only increases the {model} validity if the requested duration is greater than the current one</note><note><strong>only_decrease</strong>: Only decreases the {model} validity if the requested duration is less than the current one</note>

Example:only_decrease
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes