Vimeoconnector v1

Version 1

Connector Overview: This page documents all 183 actions for the Vimeoconnector v1.

View API Documentation

General (2)

PUT Add tags to Video

/videos/{video_id}/tags

Add tags to Video

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (1)

Option Name

Description

Name

N/A

POST Upload a Video

/me/videos

Upload a Video

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Accept

The Vimeo API version and response format.

Response Type

N/A

Options (3)

Option Name

Description

Description

N/A

Name

N/A

Tags

N/A

Albums (2)

GET Get all the albums that belong to a user

/me/albums

This method gets all the albums from the specified user's account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the albums that belong to a user

/users/{user_id}/albums

This method gets all the albums from the specified user's account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

Authorize (2)

POST Authorize a client with OAuth

/oauth/authorize/client

For information on utilizing OAuth client authorization, see ournauthentication documentation or thenClient Credentials Grant section of then[OAuth spec](https://tools.ietf.org/html/draft-ietf-oauth-v2-31.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST Convert OAuth 1 access tokens to OAuth 2 access tokens

/oauth/authorize/vimeo_oauth1

This method exchanges a legacy Advanced API OAuth 1 token for an APIv3 OAuth 2 token.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Backgrounds (2)

GET Get all the backgrounds of an On Demand page

/ondemand/pages/{ondemand_id}/backgrounds

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

DELETE Remove a background from an On Demand page

/ondemand/pages/{ondemand_id}/backgrounds/{background_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Background Id

The ID of the background.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Categories (7)

GET Get all categories

/categories

This method gets all existing categories.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the categories in a channel

/channels/{channel_id}/categories

This method gets all the categories in the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

GET Get all the categories that a user follows

/me/categories

This method gets all the categories to which a particular user has subscribed.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the categories that a user follows

/users/{user_id}/categories

This method gets all the categories to which a particular user has subscribed.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a category from a channel

/channels/{channel_id}/categories/{category}

This method removes a single category from the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Category

The name of the category.

Channel Id

The ID of the channel.

Response Type

N/A

DELETE Unsubscribe a user from a category

/me/categories/{category}

This method unsubscribes the current user from a specified category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Category

The name of the category.

Response Type

N/A

DELETE Unsubscribe a user from a category

/users/{user_id}/categories/{category}

This method unsubscribes the current user from a specified category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Category

The name of the category.

User Id

The ID of the user.

Response Type

N/A

Channels (5)

GET Get all channels

/channels

This method gets all existing channels.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the channels to which a user subscribes

/me/channels

This method gets all the channels to which the specified user subscribes.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the channels to which a user subscribes

/users/{user_id}/channels

This method gets all the channels to which the specified user subscribes.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Unsubscribe a user from a specific channel

/me/channels/{channel_id}

This method causes a user to stop following the channel in question.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

DELETE Unsubscribe a user from a specific channel

/users/{user_id}/channels/{channel_id}

This method causes a user to stop following the channel in question.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

User Id

The ID of the user.

Response Type

N/A

Comments

GET Get all the comments on a video

/videos/{video_id}/comments

This method returns all the comments on the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

Credits (2)

DELETE Delete the credit for a user in a video

/videos/{video_id}/credits/{credit_id}

This method deletes the specified user credit from a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Credit Id

The ID of the credit.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the credited users in a video

/videos/{video_id}/credits

This method returns all the credited users in a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Video Id

The ID of the video.

Response Type

N/A

Custom thumbnails (2)

GET Get all the custom upload thumbnails of an album

/users/{user_id}/albums/{album_id}/custom_thumbnails

This method gets all the custom uploaded thumbnails from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Album Id

The ID of the album.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a custom uploaded album thumbnail

/users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

This method removes a custom uploaded thumbnail from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

Thumbnail Id

The ID of the custom thumbnail.

User Id

The ID of the user.

Response Type

N/A

Customlogos (4)

GET Get a specific custom logo

/me/customlogos/{logo_id}

This method returns a single custom logo belonging to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Logo Id

The ID of the custom logo.

Response Type

N/A

GET Get a specific custom logo

/users/{user_id}/customlogos/{logo_id}

This method returns a single custom logo belonging to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Logo Id

The ID of the custom logo.

User Id

The ID of the user.

Response Type

N/A

GET Get all the custom logos that belong to a user

/me/customlogos

This method returns all the custom logos that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Get all the custom logos that belong to a user

/users/{user_id}/customlogos

This method returns all the custom logos that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Response Type

N/A

Domains (2)

GET Get all the domains on a video's whitelist

/videos/{video_id}/privacy/domains

This method returns all the domains on the specified video's whitelist.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a domain from a video's whitelist

/videos/{video_id}/privacy/domains/{domain}

This method removes the specified domain from a video's whitelist.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Domain

The domain name.

Video Id

The ID of the video.

Response Type

N/A

Following (4)

GET Get all the users that a user is following

/me/following

This method returns all users that the authenticated user is following.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the users that a user is following

/users/{user_id}/following

This method returns all users that the authenticated user is following.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Unfollow a user

/me/following/{follow_user_id}

This method causes the authenticated user to stop following another user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Follow User Id

The ID of the user to unfollow.

Response Type

N/A

DELETE Unfollow a user

/users/{user_id}/following/{follow_user_id}

This method causes the authenticated user to stop following another user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Follow User Id

The ID of the user to unfollow.

User Id

The ID of the user.

Response Type

N/A

Genres (3)

GET Get all On Demand genres

/ondemand/genres

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Get all the genres of an On Demand page

/ondemand/pages/{ondemand_id}/genres

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Response Type

N/A

DELETE Remove a genre from an On Demand page

/ondemand/pages/{ondemand_id}/genres/{genre_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Genre Id

The ID of the genre.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Groups (5)

GET Get all groups

/groups

This method returns all groups.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the groups that a user has joined

/me/groups

This method returns all the groups to which a particular user belongs.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the groups that a user has joined

/users/{user_id}/groups

This method returns all the groups to which a particular user belongs.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a user from a group

/me/groups/{group_id}

This method removes a single user from the specified group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Group Id

The ID of the group.

Response Type

N/A

DELETE Remove a user from a group

/users/{user_id}/groups/{group_id}

This method removes a single user from the specified group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Group Id

The ID of the group.

User Id

The ID of the user.

Response Type

N/A

Likes (4)

DELETE Cause a user to unlike a video

/me/likes/{video_id}

This method causes the specified user to unlike a video that they previously liked.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

DELETE Cause a user to unlike a video

/users/{user_id}/likes/{video_id}

This method causes the specified user to unlike a video that they previously liked.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the videos that a user has liked

/me/likes

This method gets all the videos that the specified user has liked.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the videos that a user has liked

/users/{user_id}/likes

This method gets all the videos that the specified user has liked.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

Logos (2)

GET Get all the custom logos of an album

/users/{user_id}/albums/{album_id}/logos

This method gets all the custom logos from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Album Id

The ID of the album.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a custom album logo

/users/{user_id}/albums/{album_id}/logos/{logo_id}

This method removes a custom logo from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

Logo Id

The ID of the custom logo.

User Id

The ID of the user.

Response Type

N/A

Me (4)

GET Get a user

/me

This method returns the representation of the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Get all the followers of a user

/me/followers

This method returns all the followers of the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the videos in a user's feed

/me/feed

This method returns all the videos in the authenticated user's feed.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Offset

The pagination offset. We recommend that you use the pagination links in the feed response instead of working with this value directly. For more details, see our pagination documentation.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Type

The feed type.

Response Type

N/A

GET Get all the videos in which a user appears

/me/appearances

This method returns all the videos in which the authenticated user has a credited appearance.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

Misc (6)

GET Get all Creative Commons licenses

/creativecommons

This method returns all available Creative Commons licenses.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Get all content ratings

/contentratings

This method returns all available content ratings.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Get all languages

/languages

This method returns all the video languages that Vimeo supports.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Response Type

N/A

GET Get an API specification

/

This method returns a full specification for the Vimeo API.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Openapi

Return an OpenAPI specification.

Response Type

N/A

GET Get started with the Vimeo API

/tutorial

This method, in conjunction with our Getting Started guide, cannhelp you learn how to use the Vimeo API.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

DELETE Revoke the current access token

/tokens

This method enables an app to notify the API that it is done with a token and that the token can be discarded.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Moderators (2)

GET Get a specific channel moderator

/channels/{channel_id}/moderators/{user_id}

This method gets a single moderator of the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a list of channel moderators

/channels/{channel_id}/moderators

This method removes multiple moderators from the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

Oauth (2)

POST Exchange an authorization code for an access token

/oauth/access_token

This method exchanges an OAuth authorization code for an OAuth access token.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET Verify an OAuth 2 token

/oauth/verify

This method verifies that an OAuth 2 token exists.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Ondemand (3)

GET Check if a user has made a purchase or rental from an On Demand page

/users/{user_id}/ondemand/purchases

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Response Type

N/A

GET Get all the On Demand pages of a user

/me/ondemand/pages

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the On Demand pages of a user

/users/{user_id}/ondemand/pages

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

Pages/{ondemand id} (2)

DELETE Delete a draft of an On Demand page

/ondemand/pages/{ondemand_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Response Type

N/A

GET Get all the users who have liked a video on an On Demand page

/ondemand/pages/{ondemand_id}/likes

This method gets all the users who have liked a particular video on an On Demand page.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Pages (2)

GET Get a specific On Demand page in a genre

/ondemand/genres/{genre_id}/pages/{ondemand_id}

Check whether a genre contains an On Demand page.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Genre Id

The ID of the genre.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

GET Get all the On Demand pages in a genre

/ondemand/genres/{genre_id}/pages

This method returns all the On Demand pages that are in a specific genre.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Genre Id

The ID of the genre.

Response Type

N/A

Pictures (8)

DELETE Delete a user picture

/me/pictures/{portraitset_id}

This method removes a portrait image from the authenticated user's Vimeo account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portraitset Id

The ID of the picture.

Response Type

N/A

DELETE Delete a user picture

/users/{user_id}/pictures/{portraitset_id}

This method removes a portrait image from the authenticated user's Vimeo account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portraitset Id

The ID of the picture.

User Id

The ID of the user.

Response Type

N/A

DELETE Delete a video thumbnail

/videos/{video_id}/pictures/{picture_id}

This method deletes the specified thumbnail image from a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Picture Id

The ID of the thumbnail.

Video Id

The ID of the video.

Response Type

N/A

GET Get a specific poster of an On Demand page

/ondemand/pages/{ondemand_id}/pictures/{poster_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Poster Id

The ID of the picture.

Response Type

N/A

GET Get all the pictures that belong to a user

/me/pictures

This method returns all the portrait images belonging to the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Response Type

N/A

GET Get all the pictures that belong to a user

/users/{user_id}/pictures

This method returns all the portrait images belonging to the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

User Id

The ID of the user.

Response Type

N/A

GET Get all the posters of an On Demand page

/ondemand/pages/{ondemand_id}/pictures

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

GET Get all the thumbnails of a video

/videos/{video_id}/pictures

This method returns all the thumbnail images of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

Portfolios (2)

GET Get all the portfolios that belong to a user

/me/portfolios

This method gets all the specified user's portfolios.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the portfolios that belong to a user

/users/{user_id}/portfolios

This method gets all the specified user's portfolios.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

Presets (2)

GET Get all the embed presets that a user has created

/me/presets

This method returns all the embed presets that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Response Type

N/A

GET Get all the embed presets that a user has created

/users/{user_id}/presets

This method returns all the embed presets that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

User Id

The ID of the user.

Response Type

N/A

Privacy/users (2)

GET Get all the users who can view a private channel

/channels/{channel_id}/privacy/users

This method gets all the users who have access to the specified private channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Channel Id

The ID of the channel.

Response Type

N/A

DELETE Restrict a user from viewing a private channel

/channels/{channel_id}/privacy/users/{user_id}

This method prevents a single user from being able to access the specified private channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

User Id

The ID of the user.

Response Type

N/A

Projects (2)

GET Get all the projects that belong to a user

/me/projects

This method gets all the projects that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the projects that belong to a user

/users/{user_id}/projects

This method gets all the projects that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

Promotions

GET Get all the promotions on an On Demand page

/ondemand/pages/{ondemand_id}/promotions

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Purchases (2)

GET Check if a user has made a purchase or rental from an On Demand page

/me/ondemand/purchases/{ondemand_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Response Type

N/A

GET Get all the On Demand purchases and rentals that a user has made

/me/ondemand/purchases

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Response Type

N/A

Regions (4)

GET Get a specific On Demand region

/ondemand/regions/{country}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Country

The country code.

Response Type

N/A

GET Get all the On Demand regions

/ondemand/regions

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

DELETE Remove a list of regions from an On Demand page

/ondemand/pages/{ondemand_id}/regions

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Response Type

N/A

DELETE Remove a specific region from an On Demand page

/ondemand/pages/{ondemand_id}/regions/{country}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Country

The country code.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Seasons

GET Get all the seasons on an On Demand page

/ondemand/pages/{ondemand_id}/seasons

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

Tags/{word} (2)

GET Get a specific tag

/tags/{word}

This method gets a specific tag from all available tags.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Word

The word to use as the tag.

Response Type

N/A

GET Get all the videos with a specific tag

/tags/{word}/videos

This method returns all the videos associated with the specified tag.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Word

The word to use as the tag.

Response Type

N/A

Tags (4)

GET Get all the tags of a video

/videos/{video_id}/tags

This method returns all the tags associated with a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Get all the tags that have been added to a channel

/channels/{channel_id}/tags

This method gets all the tags that have been added to the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

DELETE Remove a tag from a channel

/channels/{channel_id}/tags/{word}

This method removes a single tag from the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Word

The word to use as the tag.

Response Type

N/A

DELETE Remove a tag from a video

/videos/{video_id}/tags/{word}

This method removes the specified tag from a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Word

The word to use as the tag.

Response Type

N/A

Texttracks (2)

DELETE Delete a text track

/videos/{video_id}/texttracks/{texttrack_id}

This method deletes the specified text track from a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Texttrack Id

The ID of the text track.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the text tracks of a video

/videos/{video_id}/texttracks

This method returns all the text tracks of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

Timelinethumbnails (2)

POST Add a new timeline event thumbnail to a video

/videos/{video_id}/timelinethumbnails

This method adds a timeline event thumbnail to the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Get a timeline event thumbnail

/videos/{video_id}/timelinethumbnails/{thumbnail_id}

This method returns a single timeline event thumbnail that belongs to the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Thumbnail Id

The ID of the custom thumbnail.

Video Id

The ID of the video.

Response Type

N/A

Users (3)

GET Get all the users who can view a private video

/videos/{video_id}/privacy/users

This method returns all the users who have access to the specified private video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

DELETE Restrict a user from viewing a private video

/videos/{video_id}/privacy/users/{user_id}

This method prevents a user from being able to view the specified private video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

GET Search for users

/users

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

Videos (22)

GET Check for a video in a category

/categories/{category}/videos/{video_id}

This method gets a single video from a category. Use it to determine whether the video belongs to the category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Category

The name of the category.

Video Id

The ID of the video.

Response Type

N/A

GET Check if a user owns a video

/me/videos/{video_id}

This method determines whether a particular user is the owner of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Check if a user owns a video

/users/{user_id}/videos/{video_id}

This method determines whether a particular user is the owner of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the videos in a category

/categories/{category}/videos

This method gets all the videos that belong to a category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Category

The name of the category.

Response Type

N/A

GET Get all the videos in a group

/groups/{group_id}/videos

This method removes a single video from the specified group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Group Id

The ID of the group.

Response Type

N/A

GET Get all the videos in a portfolio

/me/portfolios/{portfolio_id}/videos

This method gets all the videos from the specified portfolio.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Portfolio Id

The ID of the portfolio.

Response Type

N/A

GET Get all the videos in a portfolio

/users/{user_id}/portfolios/{portfolio_id}/videos

This method gets all the videos from the specified portfolio.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Portfolio Id

The ID of the portfolio.

User Id

The ID of the user.

Response Type

N/A

GET Get all the videos in an album

/me/albums/{album_id}/videos

This method gets all the videos from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Password

The password of the album.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Weak Search

Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service performs a partial text search on the video's name.

Album Id

The ID of the album.

Response Type

N/A

GET Get all the videos in an album

/users/{user_id}/albums/{album_id}/videos

This method gets all the videos from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Password

The password of the album.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Weak Search

Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service performs a partial text search on the video's name.

Album Id

The ID of the album.

User Id

The ID of the user.

Response Type

N/A

GET Get all the videos on an On Demand page

/ondemand/pages/{ondemand_id}/videos

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Ondemand Id

The ID of the On Demand.

Response Type

N/A

GET Get all the videos that a user has uploaded

/me/videos

This method returns all the videos that the authenticated user has uploaded.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Filter Playable

Whether to filter the results by playable videos (true) or non-playable videos (false).

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the videos that a user has uploaded

/users/{user_id}/videos

This method returns all the videos that the authenticated user has uploaded.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Containing Uri

The page that contains the video URI.

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Filter Playable

Whether to filter the results by playable videos (true) or non-playable videos (false).

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a list of videos from a channel

/channels/{channel_id}/videos

This method removes multiple videos from a specific channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

DELETE Remove a list of videos from a project

/me/projects/{project_id}/videos

This method removed multiple videos from the specified project.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Should Delete Clips

Whether to delete all the videos in the project along with the project itself.

Uris

A comma-separated list of the video URIs to remove.

Project Id

The ID of the project.

Response Type

N/A

DELETE Remove a list of videos from a project

/users/{user_id}/projects/{project_id}/videos

This method removed multiple videos from the specified project.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Should Delete Clips

Whether to delete all the videos in the project along with the project itself.

Uris

A comma-separated list of the video URIs to remove.

Project Id

The ID of the project.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a specific video from a project

/me/projects/{project_id}/videos/{video_id}

This method removes a single video from the specified project.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Project Id

The ID of the project.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a specific video from a project

/users/{user_id}/projects/{project_id}/videos/{video_id}

This method removes a single video from the specified project.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Project Id

The ID of the project.

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from a group

/groups/{group_id}/videos/{video_id}

This method removes a single video from the specified group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Group Id

The ID of the group.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from a portfolio

/me/portfolios/{portfolio_id}/videos/{video_id}

This method removes a video from the specified portfolio.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portfolio Id

The ID of the portfolio.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from a portfolio

/users/{user_id}/portfolios/{portfolio_id}/videos/{video_id}

This method removes a video from the specified portfolio.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portfolio Id

The ID of the portfolio.

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from an On Demand page

/ondemand/pages/{ondemand_id}/videos/{video_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Video Id

The ID of the video.

Response Type

N/A

GET Search for videos

/videos

This method returns all the videos that match custom search criteria.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Links

A comma-separated list of video URLs to find.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Uris

A comma-separated list of the video URIs to remove.

Response Type

N/A

Watched/videos (2)

DELETE Delete a specific video from a user's watch history

/me/watched/videos/{video_id}

This method deletes the specified video from the authenticated user's watch history.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

DELETE Delete a user's watch history

/me/watched/videos

This method deletes the authenticated user's entire watch history.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Watchlater (4)

GET Get all the videos in a user's Watch Later queue

/me/watchlater

This method gets all the videos from the specified user's Watch Later queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Response Type

N/A

GET Get all the videos in a user's Watch Later queue

/users/{user_id}/watchlater

This method gets all the videos from the specified user's Watch Later queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

DELETE Remove a video from a user's Watch Later queue

/me/watchlater/{video_id}

This method removes a single video from the specified user's Watch Later queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from a user's Watch Later queue

/users/{user_id}/watchlater/{video_id}

This method removes a single video from the specified user's Watch Later queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

{album id} (2)

DELETE Delete an album

/me/albums/{album_id}

This method deletes an album from the owner's account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

Response Type

N/A

DELETE Delete an album

/users/{user_id}/albums/{album_id}

This method deletes an album from the owner's account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

User Id

The ID of the user.

Response Type

N/A

{category} (3)

GET Get a specific category

/categories/{category}

This method gets a single category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Category

The name of the category.

Response Type

N/A

GET Get all the channels in a category

/categories/{category}/channels

This method gets all the channels that belong to a category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Category

The name of the category.

Response Type

N/A

GET Get all the groups in a category

/categories/{category}/groups

This method gets all the groups that belong to a category.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Category

The name of the category.

Response Type

N/A

{channel id} (2)

DELETE Delete a channel

/channels/{channel_id}

This method deletes the specified channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Response Type

N/A

GET Get all the followers of a channel

/channels/{channel_id}/users

This method gets all the followers of a specific channel.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Channel Id

The ID of the channel.

Response Type

N/A

{comment id} (2)

DELETE Delete a video comment

/videos/{video_id}/comments/{comment_id}

This method deletes the specified comment from a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Comment Id

The ID of the comment.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the replies to a video comment

/videos/{video_id}/comments/{comment_id}/replies

This method returns all the replies to the specified video comment.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Comment Id

The ID of the comment.

Video Id

The ID of the video.

Response Type

N/A

{genre id}

GET Get a specific On Demand genre

/ondemand/genres/{genre_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Genre Id

The ID of the genre.

Response Type

N/A

{group id} (2)

DELETE Delete a group

/groups/{group_id}

This method deletes a group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Group Id

The ID of the group.

Response Type

N/A

GET Get all the members of a group

/groups/{group_id}/users

This method returns all the users that belong to the specified group.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Group Id

The ID of the group.

Response Type

N/A

{portfolio id} (2)

GET Get a specific portfolio

/me/portfolios/{portfolio_id}

This method gets a single portfolio from the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portfolio Id

The ID of the portfolio.

Response Type

N/A

GET Get a specific portfolio

/users/{user_id}/portfolios/{portfolio_id}

This method gets a single portfolio from the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Portfolio Id

The ID of the portfolio.

User Id

The ID of the user.

Response Type

N/A

{preset id} (4)

GET Get a specific embed preset

/me/presets/{preset_id}

This method returns a single embed preset that belongs to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Preset Id

The ID of the preset.

Response Type

N/A

GET Get a specific embed preset

/users/{user_id}/presets/{preset_id}

This method returns a single embed preset that belongs to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Preset Id

The ID of the preset.

User Id

The ID of the user.

Response Type

N/A

GET Get all the videos that have been added to an embed preset

/me/presets/{preset_id}/videos

This method returns all the videos that make use of the specified embed preset.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Preset Id

The ID of the preset.

Response Type

N/A

GET Get all the videos that have been added to an embed preset

/users/{user_id}/presets/{preset_id}/videos

This method returns all the videos that make use of the specified embed preset.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Preset Id

The ID of the preset.

User Id

The ID of the user.

Response Type

N/A

{project id} (2)

DELETE Delete a project

/me/projects/{project_id}

This method deletes a project and optionally also the videos that it contains.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Should Delete Clips

Whether to delete all the videos in the project along with the project itself.

Project Id

The ID of the project.

Response Type

N/A

DELETE Delete a project

/users/{user_id}/projects/{project_id}

This method deletes a project and optionally also the videos that it contains.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Should Delete Clips

Whether to delete all the videos in the project along with the project itself.

Project Id

The ID of the project.

User Id

The ID of the user.

Response Type

N/A

{promotion id} (2)

GET Get all the codes of a promotion on an On Demand page

/ondemand/pages/{ondemand_id}/promotions/{promotion_id}/codes

This method returns all the codes of a promotion on an On Demand page.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Ondemand Id

The ID of the On Demand.

Promotion Id

The ID of the promotion.

Response Type

N/A

DELETE Remove a promotion from an On Demand page

/ondemand/pages/{ondemand_id}/promotions/{promotion_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Promotion Id

The ID of the promotion.

Response Type

N/A

{season id} (2)

GET Get a specific season on an On Demand page

/ondemand/pages/{ondemand_id}/seasons/{season_id}

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Ondemand Id

The ID of the On Demand.

Season Id

The ID of the season.

Response Type

N/A

GET Get all the videos in a season on an On Demand page

/ondemand/pages/{ondemand_id}/seasons/{season_id}/videos

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Ondemand Id

The ID of the On Demand.

Season Id

The ID of the season.

Response Type

N/A

{user id} (5)

DELETE Complete a user's streaming upload

/users/{user_id}/uploads/{upload_id}

This method returns all the embed presets that belong to the specified user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Signature

The crypto signature of the completed upload.

Video File Id

The ID of the uploaded file.

Upload Id

The ID of the upload attempt.

User Id

The ID of the user.

Response Type

N/A

GET Get a user

/users/{user_id}

This method returns the representation of the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

User Id

The ID of the user.

Response Type

N/A

GET Get all the followers of a user

/users/{user_id}/followers

This method returns all the followers of the authenticated user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

GET Get all the videos in a user's feed

/users/{user_id}/feed

This method returns all the videos in the authenticated user's feed.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Offset

The pagination offset. We recommend that you use the pagination links in the feed response instead of working with this value directly. For more details, see our pagination documentation.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Type

The feed type.

User Id

The ID of the user.

Response Type

N/A

GET Get all the videos in which a user appears

/users/{user_id}/appearances

This method returns all the videos in which the authenticated user has a credited appearance.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Filter Embeddable

Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

User Id

The ID of the user.

Response Type

N/A

{video id} (19)

POST Add a version to a video

/videos/{video_id}/versions

This method adds a version to the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

DELETE Delete a video

/videos/{video_id}

This method deletes the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Get all the albums to which a user can add or remove a specific video

/videos/{video_id}/available_albums

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the categories to which a video belongs

/videos/{video_id}/categories

This method gets all the categories that contain a particular video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Get all the channels to which a user can add or remove a specific video

/videos/{video_id}/available_channels

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Video Id

The ID of the video.

Response Type

N/A

GET Get all the comments on a video

/channels/{channel_id}/videos/{video_id}/comments

This method returns all the comments on the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the credited users in a video

/channels/{channel_id}/videos/{video_id}/credits

This method returns all the credited users in a video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Query

The search query to use to filter the results.

Sort

The way to sort the results.

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the related videos of a video

/videos/{video_id}/videos

This method returns all the related videos of a particular video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Filter

The attribute by which to filter the results.nnOption descriptions:n * conditional_featured - Featured (promoted) videosn

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the text tracks of a video

/channels/{channel_id}/videos/{video_id}/texttracks

This method returns all the text tracks of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the thumbnails of a video

/channels/{channel_id}/videos/{video_id}/pictures

This method returns all the thumbnail images of the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the users who can view a private video

/channels/{channel_id}/videos/{video_id}/privacy/users

This method returns all the users who have access to the specified private video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the users who have liked a video

/channels/{channel_id}/videos/{video_id}/likes

This method gets all the users who have liked a particular video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

GET Get all the users who have liked a video

/videos/{video_id}/likes

This method gets all the users who have liked a particular video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Direction

The sort direction of the results.

Page

The page number of the results to show.

Per Page

The number of items to show on each page of results, up to a maximum of 100.

Sort

The way to sort the results.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a specific video from a channel

/channels/{channel_id}/videos/{video_id}

This method removes a single video from the channel in question.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Channel Id

The ID of the channel.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from an album

/me/albums/{album_id}/videos/{video_id}

This method removes a video from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove a video from an album

/users/{user_id}/albums/{album_id}/videos/{video_id}

This method removes a video from the specified album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A

DELETE Remove an embed preset from a video

/videos/{video_id}/presets/{preset_id}

This method removes the embed preset from the specified video.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Preset Id

The ID of the preset.

Video Id

The ID of the video.

Response Type

N/A

POST Set a video as the album thumbnail

/me/albums/{album_id}/videos/{video_id}/set_album_thumbnail

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

Video Id

The ID of the video.

Response Type

N/A

POST Set a video as the album thumbnail

/users/{user_id}/albums/{album_id}/videos/{video_id}/set_album_thumbnail

Information about this method appears below.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Album Id

The ID of the album.

User Id

The ID of the user.

Video Id

The ID of the video.

Response Type

N/A