Get list of collections

GET 
/collections

List of collections. All series are inside a "collections" element, current page and next page are specified outside the collections element.

Request

Query Parameters

page stringrequired
Page of collections to return (default is set to 1)
Example: 1
search stringrequired
String to search collections by title
Example: text
order stringrequired
Order to return collections (default desc)
Example: desc
category_ids[] stringrequired
Category ids to attach on this collection
Example: 7789

Header Parameters

Accept stringrequired
Example: application/json

Responses

200

Response Headers

application/json

Schema

Schema

status stringrequired

collections

object[]

required

Array [

tags stringrequired

title stringrequired

description stringrequired

id stringrequired

display_name stringrequired

full_description stringrequired

privacy stringrequired

img_preview stringrequired

img_preview_vertical stringrequired

img_preview_background stringrequired

img_preview_logo_title stringrequired

total_live stringrequired

total_videos stringrequired

total_ondemand stringrequired

category stringrequired

trailer stringrequired

views stringrequired

show_views stringrequired

likes_tot stringrequired

show_likes stringrequired

subtitles stringrequired

on_sale stringrequired

json_price stringrequired

channel stringrequired

access stringrequired

channel_display_name stringrequired

saved stringrequired

geoblocking stringrequired

android_products stringrequired

ios_products stringrequired

directors stringrequired

actors stringrequired

age_restriction stringrequired

original_language stringrequired

customfields stringrequired

full_original_language stringrequired

year stringrequired

next_video_play stringrequired

seo_title stringrequired

seo_description stringrequired

duration stringrequired

show_ads_on_free stringrequired

]

Example (from schema)

{
  "status": "string",
  "collections": [
    {
      "tags": "string",
      "title": "string",
      "description": "string",
      "id": "string",
      "display_name": "string",
      "full_description": "string",
      "privacy": "string",
      "img_preview": "string",
      "img_preview_vertical": "string",
      "img_preview_background": "string",
      "img_preview_logo_title": "string",
      "total_live": "string",
      "total_videos": "string",
      "total_ondemand": "string",
      "category": "string",
      "trailer": "string",
      "views": "string",
      "show_views": "string",
      "likes_tot": "string",
      "show_likes": "string",
      "subtitles": "string",
      "on_sale": "string",
      "json_price": "string",
      "channel": "string",
      "access": "string",
      "channel_display_name": "string",
      "saved": "string",
      "geoblocking": "string",
      "android_products": "string",
      "ios_products": "string",
      "directors": "string",
      "actors": "string",
      "age_restriction": "string",
      "original_language": "string",
      "customfields": "string",
      "full_original_language": "string",
      "year": "string",
      "next_video_play": "string",
      "seo_title": "string",
      "seo_description": "string",
      "duration": "string",
      "show_ads_on_free": "string"
    }
  ]
}

1

OK

{
  "status": "<string>",
  "collections": [
    {
      "tags": "<string>",
      "title": "<string>",
      "description": "<string>",
      "id": "<string>",
      "display_name": "<string>",
      "full_description": "<string>",
      "privacy": "<string>",
      "img_preview": "<string>",
      "img_preview_vertical": "<string>",
      "img_preview_background": "<string>",
      "img_preview_logo_title": "<string>",
      "total_live": "<string>",
      "total_videos": "<string>",
      "total_ondemand": "<string>",
      "category": "<string>",
      "trailer": "<string>",
      "views": "<string>",
      "show_views": "<string>",
      "likes_tot": "<string>",
      "show_likes": "<string>",
      "subtitles": "<string>",
      "on_sale": "<string>",
      "json_price": "<string>",
      "channel": "<string>",
      "access": "<string>",
      "channel_display_name": "<string>",
      "saved": "<string>",
      "geoblocking": "<string>",
      "android_products": "<string>",
      "ios_products": "<string>",
      "directors": "<string>",
      "actors": "<string>",
      "age_restriction": "<string>",
      "original_language": "<string>",
      "customfields": "<string>",
      "full_original_language": "<string>",
      "year": "<string>",
      "next_video_play": "<string>",
      "seo_title": "<string>",
      "seo_description": "<string>",
      "duration": "<string>",
      "show_ads_on_free": "<string>"
    },
    {
      "tags": "<string>",
      "title": "<string>",
      "description": "<string>",
      "id": "<string>",
      "display_name": "<string>",
      "full_description": "<string>",
      "privacy": "<string>",
      "img_preview": "<string>",
      "img_preview_vertical": "<string>",
      "img_preview_background": "<string>",
      "img_preview_logo_title": "<string>",
      "total_live": "<string>",
      "total_videos": "<string>",
      "total_ondemand": "<string>",
      "category": "<string>",
      "trailer": "<string>",
      "views": "<string>",
      "show_views": "<string>",
      "likes_tot": "<string>",
      "show_likes": "<string>",
      "subtitles": "<string>",
      "on_sale": "<string>",
      "json_price": "<string>",
      "channel": "<string>",
      "access": "<string>",
      "channel_display_name": "<string>",
      "saved": "<string>",
      "geoblocking": "<string>",
      "android_products": "<string>",
      "ios_products": "<string>",
      "directors": "<string>",
      "actors": "<string>",
      "age_restriction": "<string>",
      "original_language": "<string>",
      "customfields": "<string>",
      "full_original_language": "<string>",
      "year": "<string>",
      "next_video_play": "<string>",
      "seo_title": "<string>",
      "seo_description": "<string>",
      "duration": "<string>",
      "show_ads_on_free": "<string>"
    }
  ]
}

400

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Bad Request

{
  "status": "<string>"
}

401

Response Headers

*/*

Schema

Schema

object

Example (from schema)

{}

1

Unauthorized

<string>

404

Response Headers

*/*

Schema

Schema

object

Example (from schema)

{}

1

Not Found

<string>

Loading...