Portfolios

Add a video to a portfolio

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

The video was added.

404 Not Found

If portfolio was not found.

404 Not Found

If video was not found.

Get a specific portfolio

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

The portfolio was returned.

Get a specific video in a portfolio

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

The video was returned.

Get all the portfolios that belong to a user

GET https://api.vimeo.com/me/portfolios Playground
GET https://api.vimeo.com/users/{user_id}/portfolios Playground
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

query string No

The search query.

sort enum
  • alphabetical
  • date
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The portfolios were returned.

Get all the videos in a portfolio

GET https://api.vimeo.com/me/portfolios/{portfolio_id}/videos Playground
GET https://api.vimeo.com/users/{user_id}/portfolios/{portfolio_id}/videos Playground
Name Type Required Description
containing_uri uri No

The page that contains the video URI.

filter enum
  • embeddable
No

The filter to apply to the results.

filter_embeddable boolean No

Whether to filter by all embeddable videos or by all videos that are not embeddable. *Required only if filter is embeddable.

page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

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

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The videos were returned.

Remove a video from a portfolio

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

The video was deleted.

404 Not Found

If portfolio was not found.

404 Not Found

If video was not found.

Send Feedback