Users

Add a video to a users' Watch Later queue

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

Add a video to a users' 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

404 Not Found

If the portfolio cannot be found.

404 Not Found

If the video cannot be found.

Check if a user has a video in their Watch Later queue

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

404 Not Found

If the video cannot be found.

Check if a user is following another user

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

Complete a users' streaming upload

DELETE https://api.vimeo.com/users/{user_id}/tickets/{ticket} Playground
This method requires a token with the "upload" scope.
Name Type Required Description
signature string Yes

The crypto signature of the completed upload.

video_file_id integer Yes

The ID of the uploaded file.

HTTP Status Code Explanation
201 Created

404 Not Found

If the video file cannot be found.

404 Not Found

If the signature cannot be found.

400 Bad Request

If the signature provided is not valid.

500 Internal Server Error

If the upload did not complete successfully.

Delete a users' picture

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

Delete a video from a users' Watch Later queue

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

Delete a video from a users' 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

404 Not Found

If the portfolio cannot be found.

404 Not Found

If the video cannot be found.

Edit a user

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

Edit a users' embed preset

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

Follow a list of users

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

Follow a user

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

Get a user

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

Get a users' embed preset

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

Get a users' upload ticket

GET https://api.vimeo.com/users/{user_id}/tickets/{ticket} Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
204 No Content

Get a video within a users' 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

Get all embed presets a user has

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

Get all users that a user is following

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

Get all users that follow a user

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

Get all videos a user appears in

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

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Get all videos in a users' Watch Later queue

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

Get all videos in a users' feed

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

Get all videos with a users' embed preset

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

Get all videos within a users' 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
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

Search for users

GET https://api.vimeo.com/users 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 Yes

Search query.

sort string
  • alphabetical
  • date
  • relevant
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

503 Service Unavailable

If search is disabled.

500 Internal Server Error

If there was an internal error with our search infrastructure.

Unfollow a user

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

Send Feedback