Series

There are definitely times when stand-alone shows are more suitable, such as time-specific pieces including latest releases or news posts. However, creating a show series provides you with multiple opportunities to engage your target audience. You can really get to grips with complex topics and impart far more valuable information than with a stand-alone show.

Get Get User Series

gethttps://cache.showwcase.com/user/:username/series

Get Get Featured Series

gethttps://cache.showwcase.com/series/featured

Get Get Series

gethttps://cache.showwcase.com/projects/series/:seriesId

Post Create Series

Each new series is created in draft state by default, such series will not be visible in public feeds until you publish them.

posthttps://cache.showwcase.com/projects/series

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Get Get Series Drafts

gethttps://cache.showwcase.com/profile/series/drafts

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Query

Field	Type	Description
skip Default value: 0	number	Pagination offset.
limit Default value: 15	number	Pagination limit. (Max value 100)

Put Update Series

puthttps://cache.showwcase.com/projects/series/:seriesId

Headers

Field	Description
Authorization	An access token that represents the user who wants to take an action. Read more about access tokens here.

Body

Field	Type	Description
title	string	Series title.
description	string	Series title.
categoryId	number|number[]	Unique category Id(s).
difficulty Default value: beginner	string	Series difficulty level. Allowed values: beginner, intermediate, expert
seo	object	SEO properties.
settings	object	Custom settings.

Delete Delete Series

deletehttps://cache.showwcase.com/projects/series/:seriesId

Headers

Field	Description
Authorization	An access token that represents the user who wants to take an action. Read more about access tokens here.

Post Publish Series

posthttps://cache.showwcase.com/projects/series/:seriesId/publish

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Bulk update list of shows in Series

To update list of shows all at once.

posthttps://cache.showwcase.com/projects/series/:seriesId

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Parameters

Field	Type	Description
seriesId	string	Unique series id.

Body

Field	Type	Description
projects	array	Array of objects that contains unique shows.
projects.projectId	number	Unique project id.
level	number
depth	number

Post Add Show to Series

posthttps://cache.showwcase.com/projects/:projectId/series/:seriesId

Headers

Field	Description
X-API-KEY	An API key that represents the user who wants to take an action. Read more about API keys here.

Body

Field	Type	Description
level	number	Show order level.
depth	number	Show order depth.

Parameters

Field	Type	Description
projectId	number	Unique project's id.
seriesId	number	Unique series' id.

Delete Remove Show from Series

deletehttps://cache.showwcase.com/projects/:projectId/series/:seriesId

Headers

Field	Description
Authorization	An access token that represents the user who wants to take an action. Read more about access tokens here.

Parameters

Field	Type	Description
projectId	number	Unique project's id.
seriesId	number	Unique series' id.

Series Categories

gethttps://cache.showwcase.com/projects/series/categories

Query

Field	Type	Description
search	string	Search by categories title.