Developer / API / Endpoints

api.vimeo.com/albums

Albums

Add a video to an album

PUT https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
PUT https://api.vimeo.com/users/{user_id}/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.

Create an album

POST https://api.vimeo.com/me/albums Playground
POST https://api.vimeo.com/users/{user_id}/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

The album's password. Required if privacy=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.

Delete a video from an album

DELETE https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
DELETE https://api.vimeo.com/users/{user_id}/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.

Delete an album

DELETE https://api.vimeo.com/me/albums/{album_id} Playground
DELETE https://api.vimeo.com/users/{user_id}/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.

Edit an album

PATCH https://api.vimeo.com/me/albums/{album_id} Playground
PATCH https://api.vimeo.com/users/{user_id}/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.

Get a video within an album

GET https://api.vimeo.com/me/albums/{album_id}/videos/{video_id} Playground
GET https://api.vimeo.com/users/{user_id}/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.

Get all users' albums

GET https://api.vimeo.com/me/albums Playground
GET https://api.vimeo.com/users/{user_id}/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.

Get all videos in an album

GET https://api.vimeo.com/me/albums/{album_id}/videos Playground
GET https://api.vimeo.com/users/{user_id}/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.

Get an album

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

404 Not Found

If the album cannot be found.

Set multiple videos to an album

PUT https://api.vimeo.com/me/albums/{album_id}/videos Playground
PUT https://api.vimeo.com/users/{user_id}/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.
Send Feedback