HomeAPI Reference
API Reference

List Playlists

get
https://api.zype.com/playlists
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by ID Example: id=5992f328ce593000ef000008

string

Filter by keyword

string | null
enum

Filter by active, inactive, or all. If excluded, query will default to 'true'

Allowed:
string

Filter by title

string

Filter by friendly title

string

Filter playlists that have the video_id Example: video_id=5992f328ce593000ef000001 Matches all playlists having the video.

string

Filter records by created date using times in ISO8601 format (Example: 2017-01-01T00:00:00-00:00) or Unix timestamps (Example: 1483228800) Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: created_at.gte)

category
object

Filter records that match all category values listed. Example: category[genre][]=comedy&category[language][]=english Matches all playlists having ALL of the category name/value pairs listed.

category_or
object

Filter records that match any category values listed. Example: category_or[genre][]=comedy&category_or[language][]=english Matches all playlists that have ANY of the category name/value pairs listed.

category_and
object

Filter records that match all category values listed. Example: category[genre][]=comedy&category[language][]=english Matches all playlists having ALL of the category name/value pairs listed.

zobject_id
array of strings

Filter records that match any of the Zobject IDs listed

zobject_id
zobject_id_or
array of strings

Filter records that match any of the Zobject IDs listed

zobject_id_or
zobject_id_and
array of strings

Filter records that match all of the Zobject IDs listed

zobject_id_and
boolean

Setting to true will display the full Zobject details, including any custom attributes, for each video record returned in your query.

string

Filter zobject details by Zobject type. Example: zobject_types=episode,season

string

Filter returned zobject fields. Example: zobject_fields=title,description

string

Filter returned fields. Example: response_fields=id,title,description

string
enum

Filter by ascending or descending order

Allowed:
string

Sort on the specified field

integer

Page number to return, with per_page dictating page size

integer

Number of records to return per page

Responses

Updated 3 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago