api.vimeo.com/me

Information

View one user

GET https://api.vimeo.com/me Playground
HTTP Status Code Explanation
200 OK

Edit one user

PATCH https://api.vimeo.com/me Playground
Name Type Required Description
bio string No

The user's bio

location string No

The user's location

name string No

The user's display name

videos.privacy.add boolean No

Sets the default add setting for all future videos uploaded by this user. If true, anyone can add the video to an album, channel, or group.

videos.privacy.comments string
  • anybody
  • contacts
  • nobody
No

Sets the default comment setting for all future videos uploaded by this user. It specifies who can comment on the video.

videos.privacy.download boolean No

Sets the default download setting for all future videos uploaded by this user. If true, the video can be downloaded by any user.

videos.privacy.embed string
  • private
  • public
  • whitelist
No

Sets the default embed setting for all future videos uploaded by this user. Whitelist allows you to define all valid embed domains. Check out our docs for adding and removing domains.

videos.privacy.view string
  • anybody
  • contacts
  • disable
  • nobody
  • password
  • unlisted
  • users
No

Sets the default view setting for all future videos uploaded by this user. It specifies who can view the video.

HTTP Status Code Explanation
200 OK

Albums

View one album

GET https://api.vimeo.com/me/albums/{album_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the album cannot be found

Edit an album

PATCH https://api.vimeo.com/me/albums/{album_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
description string No

The Album's new description

name string No

The Album's new title

privacy string
  • anybody
  • password
No

The Album's new privacy level

sort string
  • added_first
  • added_last
  • alphabetical
  • arranged
  • comments
  • likes
  • newest
  • oldest
  • plays
No

The new default sort for the Album

HTTP Status Code Explanation
200 OK

403 Forbidden

If the authenticated user does not own the Album.

400 Bad Request

If one of the parameters is invalid.

403 Forbidden

if the token does not have the proper scopes.

403 Forbidden

if the authenticated user does not have permission to edit this album.

Delete an album

DELETE https://api.vimeo.com/me/albums/{album_id} Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

if the token does not have the proper scopes.

404 Not Found

If the Album cannot be found

403 Forbidden

If the authenticated user does not have permission to delete this album.

View a users albums

GET https://api.vimeo.com/me/albums Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
  • duration
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

400 Bad Request

If one of the parameters is invalid.

Create an album

POST https://api.vimeo.com/me/albums Playground
This method requires a token with the "create" scope.
Name Type Required Description
description string Yes

The Album description

name string Yes

The Album title

password string No

Required if privacy=password. The Album's password

privacy string
  • anybody
  • password
No

The Album's privacy level

sort string
  • added_first
  • added_last
  • alphabetical
  • arranged
  • comments
  • likes
  • newest
  • oldest
  • plays
No

The default sort order of an Album's videos

HTTP Status Code Explanation
200 OK

400 Bad Request

If one of the parameters is invalid.

403 Forbidden

if the token does not have the proper scopes.

403 Forbidden

if the authenticated user does not have permission to create an album.

Videos

Check for a video

GET https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the Album cannot be found

404 Not Found

If the video cannot be found in the Album

Add one video

PUT https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the token does not have the proper scopes.

404 Not Found

If the Album cannot be found

403 Forbidden

If the authenticated user does not have permission to edit the Album.

Remove one video

DELETE https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the token does not have the proper scopes.

404 Not Found

If the Album cannot be found

403 Forbidden

If the authenticated user does not have permission to edit the Album.

List all videos

GET https://api.vimeo.com/me/albums/{album_id}/videos Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • comments
  • date
  • duration
  • likes
  • manual
  • modified_time
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the Album cannot be found

Add many videos

PUT https://api.vimeo.com/me/albums/{album_id}/videos Playground
This method requires a token with the "edit" scope.
Name Type Required Description
videos string Yes

Comma-separated list of video uris

HTTP Status Code Explanation
201 Created

404 Not Found

If the Album cannot be found

403 Forbidden

If the authenticated user doesn't have permission to create Albums.

Appearances

View all videos a user is credited in

GET https://api.vimeo.com/me/appearances Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • comments
  • date
  • durection
  • likes
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Categories

View all categories a user follows

GET https://api.vimeo.com/me/categories Playground
Name Type Required Description
direction string No

The direction that the results are sorted.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

sort string
  • alphabetical
  • date
  • name
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

403 Forbidden

When trying to view another user.

Error Code: 3200

Check for a category

GET https://api.vimeo.com/me/categories/{category} Playground
HTTP Status Code Explanation
204 No Content

Subscribe to a category

PUT https://api.vimeo.com/me/categories/{category} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

Un-subscribe from a category

DELETE https://api.vimeo.com/me/categories/{category} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

Channels

Check for a channel

GET https://api.vimeo.com/me/channels/{channel_id} Playground
HTTP Status Code Explanation
204 No Content

404 Not Found

If the Channel cannot be found

Subscribe to a channel

PUT https://api.vimeo.com/me/channels/{channel_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

Unsubscribe from a channel

DELETE https://api.vimeo.com/me/channels/{channel_id} Playground
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the Channel is not found.

View all channels

GET https://api.vimeo.com/me/channels Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • moderated
No

Filter to apply to the results.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
  • followers
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
304 Not Modified

If no Channel has been followed since the provided If-Modified-Since header.

200 OK

Feed

View all videos in your feed

GET https://api.vimeo.com/me/feed Playground
This method requires a token with the "private" scope.
Name Type Required Description
offset string Yes

This is necessary for proper pagination. Do not provide this value yourself, just use the pagination links provided in the feed response

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

HTTP Status Code Explanation
200 OK

Followers

View all followers

GET https://api.vimeo.com/me/followers Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Following

Check if following a user

GET https://api.vimeo.com/me/following/{follow_user_id} Playground
HTTP Status Code Explanation
204 No Content

404 Not Found

If the authenticated user is not followed by the current user.

Follow a user

PUT https://api.vimeo.com/me/following/{follow_user_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user is not allowed to add follows.

Unfollow a user

DELETE https://api.vimeo.com/me/following/{follow_user_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

View followed users

GET https://api.vimeo.com/me/following Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • online
No

Filter to apply to the results.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Batch in a list of users to follow.

POST https://api.vimeo.com/me/following Playground
This method requires a token with the "interact" scope.
Name Type Required Description
users string Yes

Array of user URI's to follow.

HTTP Status Code Explanation
204 No Content

401 Unauthorized

If a bad user access token was supplied.

Error Code: 8000

403 Forbidden

If the current user cannot follow users.

Error Code: 3417

400 Bad Request

If no request body was supplied.

Error Code: 2205

400 Bad Request

If an invalid list of users was supplied.

Error Code: 2205

400 Bad Request

If the supplied list of users does not contain URI's.

Error Code: 2205

400 Bad Request

If a user in the supplied list of users does not exist.

Error Code: 2900

400 Bad Request

If more than 100 users were supplied in the list.

Error Code: 2901

500 Internal Server Error

If an unexpected error occurred.

Error Code: 4005

429 Too Many Requests

If the current user is rate limited from following users.

Error Code: 9006

Groups

Check if user joined group

GET https://api.vimeo.com/me/groups/{group_id} Playground
HTTP Status Code Explanation
204 No Content

404 Not Found

If the Group cannot be found

404 Not Found

If the authenticated user is not a member of this Group.

Join a group

PUT https://api.vimeo.com/me/groups/{group_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user is not allowed to join Groups.

403 Forbidden

If the Group prohibits the authenticated user from joining (not public, or privacy setting is `members`).

Leave a group

DELETE https://api.vimeo.com/me/groups/{group_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user owns the Group (a new Group owner must be applied first via `PATCH`).

Get all joined groups

GET https://api.vimeo.com/me/groups Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • moderated
No

Filter to apply to the results.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
  • members
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Likes

Check if liked

GET https://api.vimeo.com/me/likes/{video_id} Playground
HTTP Status Code Explanation
204 No Content

404 Not Found

If the video cannot be found

Like one video

PUT https://api.vimeo.com/me/likes/{video_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user is not allowed to like videos.

400 Bad Request

If the video is owned by the authenticated user.

Unlike one video

DELETE https://api.vimeo.com/me/likes/{video_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user is not allowed to like videos.

View all liked videos

GET https://api.vimeo.com/me/likes Playground
Name Type Required Description
direction string No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • comments
  • date
  • duration
  • likes
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

On Demand

View pages for user

GET https://api.vimeo.com/me/ondemand/pages Playground
Name Type Required Description
filter string
  • film
  • series
Yes

Type of On Demand pages to display

page integer No

The page number to show. Page for paging

per_page integer No

Number of items to show on each page. Max 100. How many On Demand pages to display at a time

sort string
  • added
  • modified_time
  • name
  • publish.time
  • rating
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the user cannot be found

Create page

POST https://api.vimeo.com/me/ondemand/pages Playground
Name Type Required Description
accepted_currencies string No

List of accepted currencies.

buy.active boolean No

Required if rent.active is false.

buy.download boolean No

If download is available to purchasers who buy the film.

buy.price.AUD float No

The purchase price of this video in AUD.

buy.price.CAD float No

The purchase price of this video in CAD.

buy.price.CHF float No

The purchase price of this video in CHF.

buy.price.DKK float No

The purchase price of this video in DKK.

buy.price.EUR float No

The purchase price of this video in EUR.

buy.price.GBP float No

The purchase price of this video in GBP.

buy.price.JPY float No

The purchase price of this video in JPY.

buy.price.KRW float No

The purchase price of this video in KRW.

buy.price.NOK float No

The purchase price of this video in NOK.

buy.price.PLN float No

The purchase price of this video in PLN.

buy.price.SEK float No

The purchase price of this video in SEK.

buy.price.USD float No

Required if buy.active is true. If this On Demand page is a film, this is the price to purchase the film. If series, this is the price to purchase the entire collection.

content_rating string
  • drugs
  • language
  • nudity
  • safe
  • unrated
  • violence
Yes

One or more ratings, comma separated or JSON array depending on your request format.

description string Yes

The On Demand page description.

domain_link string No

The On Demand page's custom domain.

episodes.buy.active boolean No

Whether episodes can be bought

episodes.buy.download boolean No

If download is available to purchasers who buy the episode.

episodes.buy.price.USD float No

Required if episodes.buy.active is true.

episodes.rent.active boolean No

Whether episodes can be rented

episodes.rent.period string No

Required if episodes.rent.active is true.

episodes.rent.price.USD float No

Required if episodes.rent.active is true. Only applicable if this On Demand page is a series. This is the default price for each individual episode.

link string No

The custom string to use in this On Demand page's Vimeo URL.

name string Yes

The On Demand page name.

rent.active boolean No

Required if buy.active is false.

rent.period string No

Required if rent.active is true.

rent.price.AUD float No

The rental price of this video in AUD.

rent.price.CAD float No

The rental price of this video in CAD.

rent.price.CHF float No

The rental price of this video in CHF.

rent.price.DKK float No

The rental price of this video in DKK.

rent.price.EUR float No

The rental price of this video in EUR.

rent.price.GBP float No

The rental price of this video in GBP.

rent.price.JPY float No

The rental price of this video in JPY.

rent.price.KRW float No

The rental price of this video in KRW.

rent.price.NOK float No

The rental price of this video in NOK.

rent.price.PLN float No

The rental price of this video in PLN.

rent.price.SEK float No

The rental price of this video in SEK.

rent.price.USD float No

Required if rent.active is true. If this On Demand page is a film, this is the price to rent the film. If series, this is the price to rent the entire collection.

subscription.monthly.active boolean No

Required if rent.active and buy.active are false.

subscription.monthly.price.USD float No

Required if subscription.active is true.

type string
  • film
  • series
Yes

The On Demand page type.

HTTP Status Code Explanation
200 OK

On Demand Purchases

Check if an On Demand page is in your purchases.

GET https://api.vimeo.com/me/ondemand/purchases/{ondemand_id} Playground
This method requires a token with the "purchased" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the user cannot be found

404 Not Found

If the On Demand page cannot be found in the purchases

403 Forbidden

If the requested user is not the same as the authenticated user.

Get users OnDemand Purchases and Rentals

GET https://api.vimeo.com/me/ondemand/purchases Playground
This method requires a token with the "purchased" scope.
Name Type Required Description
filter string
  • all
  • expiring_soon
  • film
  • important
  • purchased
  • rented
  • series
  • subscription
  • unwatched
  • watched
Yes

Which type of On Demand videos to show. important will show all pages which are about to expire

sort string
  • added
  • alphabetical
  • date
  • name
  • purchase_time
  • rating
  • release_date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

400 Bad Request

If you have not provided a filter.

403 Forbidden

If the requested user is not the same as the authenticated user.

Pictures

Remove a portrait

DELETE https://api.vimeo.com/me/pictures/{portraitset_id} Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

Portfolios

View one portfolio

GET https://api.vimeo.com/me/portfolios/{portfolio_id} Playground
HTTP Status Code Explanation
200 OK

View all portfolios

GET https://api.vimeo.com/me/portfolios Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Portfolio Videos

View one video

GET https://api.vimeo.com/me/portfolios/{portfolio_id}/videos/{video_id} Playground
HTTP Status Code Explanation
200 OK

Add video

PUT https://api.vimeo.com/me/portfolios/{portfolio_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the Portfolio cannot be found

404 Not Found

If the video cannot be found

Remove video

DELETE https://api.vimeo.com/me/portfolios/{portfolio_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the Portfolio cannot be found

404 Not Found

If the video cannot be found

View all videos

GET https://api.vimeo.com/me/portfolios/{portfolio_id}/videos Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

sort string
  • alphabetical
  • comments
  • date
  • default
  • likes
  • manual
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Presets

View one preset

GET https://api.vimeo.com/me/presets/{preset_id} Playground
HTTP Status Code Explanation
200 OK

Edit one preset

PATCH https://api.vimeo.com/me/presets/{preset_id} Playground
Name Type Required Description
outro string
  • nothing
No

Disable the outro. Currently we only support disabling outros, let us know if you need additional features!

HTTP Status Code Explanation
200 OK

404 Not Found

If the preset does not exist.

404 Not Found

If the authenticated user does not own the preset.

400 Bad Request

If an unsupported outro type is provided.

View all presets

GET https://api.vimeo.com/me/presets Playground
Name Type Required Description
page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

HTTP Status Code Explanation
200 OK

Video Presets

View videos for preset

GET https://api.vimeo.com/me/presets/{preset_id}/videos Playground
HTTP Status Code Explanation
200 OK

Videos

Check for one video

GET https://api.vimeo.com/me/videos/{video_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the video is not owned by the authenticated user.

View videos

GET https://api.vimeo.com/me/videos Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • app_only
  • embeddable
  • playable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

filter_playable string
  • false
  • true
No

Default true. Choose between only videos that are playable, and only videos that are not playable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • comments
  • date
  • default
  • duration
  • likes
  • modified_time
  • plays
No

Technique used to sort the results.

weak_search boolean No

This forces the query parameter to use a separate search service that includes private videos. It will only perform a partial text search on the video's name. In the future the standard search will include private videos, and this parameter won't be necessary.

HTTP Status Code Explanation
304 Not Modified

If no videos were created by this user since the provided If-Modified-Since header.

200 OK

Upload one video

POST https://api.vimeo.com/me/videos Playground
This method requires a token with the "upload" scope.
Name Type Required Description
link string Yes

If your upload type is pull, Vimeo will download the video hosted at this public URL. This URL must be valid for at least 24 hours.

redirect_url string Yes

The app redirect URL

type string
  • POST
  • pull
  • streaming
Yes

Upload type

HTTP Status Code Explanation
201 Created

403 Forbidden

If the upload quota is exceeded.

Watch Later

Check for video

GET https://api.vimeo.com/me/watchlater/{video_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the video cannot be found

Add video

PUT https://api.vimeo.com/me/watchlater/{video_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

Remove a video

DELETE https://api.vimeo.com/me/watchlater/{video_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

View all videos

GET https://api.vimeo.com/me/watchlater Playground
This method requires a token with the "private" scope.
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable string
  • false
  • true
No

Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • comments
  • date
  • duration
  • likes
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
304 Not Modified

If no video has been added to the users' watch later queue since the provided If-Modified-Since header.

200 OK

Watched Videos

Remove a video from your watch history.

DELETE https://api.vimeo.com/me/watched/videos/{video_id} Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

View all videos you have watched

GET https://api.vimeo.com/me/watched/videos Playground
HTTP Status Code Explanation
200 OK

Clear your entire watch history

DELETE https://api.vimeo.com/me/watched/videos Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

Send Feedback