Albums

Add a custom album logo

POST https://api.vimeo.com/users/{user_id}/albums/{album_id}/logos Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
201 Created

The album logo was created.

404 Not Found

If album was not found.

403 Forbidden

The authenticated user cannot modify this album.

Add a list of videos to an album

Replace or clear the videos in 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

A comma-separated list of video URIs.

HTTP Status Code Explanation
201 Created

The videos were added.

404 Not Found

If album was not found.

403 Forbidden

The authenticated user cannot create albums.

Add a specific 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

The video was added.

403 Forbidden

The token does not have the proper scopes.

404 Not Found

If album was not found.

403 Forbidden

The authenticated user cannot 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
brand_color string No

Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons.

description string Yes

The album description.

hide_nav boolean No

Whether to hide the Vimeo navigation when viewing the album.

layout enum
  • grid
  • player
No

The album's layout preference

name string Yes

The album title.

password string No

The album's password. *Required only if privacy is password.

privacy enum
  • anybody
  • embed_only
  • password
No

The album's privacy level.

review_mode boolean No

Whether album videos should use the review mode URL.

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

The default sort order of an album's videos.

theme enum
  • dark
  • standard
No

The albums's color theme preference

HTTP Status Code Explanation
201 Created

The album was created.

400 Bad Request

A parameter is invalid.

403 Forbidden

The token does not have the proper scopes.

403 Forbidden

The authenticated user cannot create an 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

The album was deleted.

403 Forbidden

The token does not have the proper scopes.

404 Not Found

If album was not found.

403 Forbidden

The authenticated user cannot delete this album.

Edit a custom album logo

PATCH https://api.vimeo.com/users/{user_id}/albums/{album_id}/logos/{logo_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
active boolean No

Whether to make this the active album logo.

HTTP Status Code Explanation
200 OK

The album logo was edited.

404 Not Found

If album was not found.

404 Not Found

If album logo was not found.

403 Forbidden

You cannot modify an album that you do not own.

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
brand_color string No

Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons.

description string No

The description of the album.

hide_nav boolean No

Whether to hide the Vimeo navigation when viewing the album.

layout enum
  • grid
  • player
No

The album's layout preference

name string No

The title of the album.

password string No

The album's password. *Required only if privacy is password.

privacy enum
  • anybody
  • embed_only
  • password
No

The album's privacy level.

review_mode boolean No

Whether album videos should use the review mode URL.

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

The default sort order for album.

theme enum
  • dark
  • standard
No

The albums's color theme preference

HTTP Status Code Explanation
200 OK

The album was edited.

403 Forbidden

The authenticated user does not own the album.

400 Bad Request

A parameter is invalid.

403 Forbidden

The token does not have the proper scopes.

403 Forbidden

The authenticated user cannot edit this album.

Get a specific 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

The album was returned.

404 Not Found

If album was not found.

Get a specific custom album logo

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

The album logo was returned.

404 Not Found

If album was not found.

404 Not Found

If album logo was not found.

403 Forbidden

You cannot view another user's album logo.

Get a specific video in an album

Check if an album contains a video.

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
Name Type Required Description
password string No

The album's password.

HTTP Status Code Explanation
200 OK

The video was returned.

404 Not Found

If album was not found.

404 Not Found

If video was not found in the album.

Get all the albums that belong to a user

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

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The albums were returned.

400 Bad Request

A parameter is invalid.

Get all the custom logos of an album

GET https://api.vimeo.com/users/{user_id}/albums/{album_id}/logos Playground
Name Type Required Description
page integer No

The page number to show.

per_page integer No

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

HTTP Status Code Explanation
200 OK

The album logos were returned.

404 Not Found

If album was not found.

Get all the 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
containing_uri uri No

The page containing the video URI.

direction enum
  • asc
  • desc
No

The sort direction of the results.

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.

password string No

The album's password.

per_page integer No

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

query string No

The search query.

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

The technique for sorting the results.

weak_search boolean No

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.)

HTTP Status Code Explanation
200 OK

The videos were returned.

404 Not Found

If album was not found.

Remove a custom album logo

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

The album logo was deleted.

404 Not Found

If album was not found.

404 Not Found

If album logo was not found.

403 Forbidden

If you are attempting to modify an album that you do not own.

Remove 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

The video was removed.

403 Forbidden

The token does not have the proper scopes.

404 Not Found

If album was not found.

403 Forbidden

The authenticated user cannot edit the album.

Send Feedback