Users

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

The authenticated user follows the user in question.

404 Not Found

The user in question does not follow the authenticated user.

Create a user picture

POST https://api.vimeo.com/me/pictures Playground
POST https://api.vimeo.com/users/{user_id}/pictures Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
200 OK

The user picture was created.

Delete a user's 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

The picture was deleted.

Delete a user's 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

The watch history was deleted.

Delete 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

The video was deleted from your watch history.

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.

content_filter array No

A list of values describing the content in this video. Find the full list in the /contentratings endpoint. You must provide a comma-separated list if you are using a query string or an array if you are using JSON.

link string No

The user's custom Vimeo URL slug.

location string No

The user's location.

name string No

The user's display name.

password string No

The default password for all future videos that this user uploads. To use this field, the videos.privacy.view field must be password.

videos.privacy.add boolean No

Whether a user can add the video to an album, channel, or group. This value becomes the default add setting for all future videos uploaded by the user.

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

Who can comment on the video. This value becomes the default comment setting for all future videos that this user uploads.

videos.privacy.download boolean No

Whether a user can download the video. This value becomes the default download setting for all future videos that this user uploads.

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

The privacy for embed videos. The whitelist value enables you to define all valid embed domains. See our documentation for adding and removing domains.

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

Who can view the video. This value becomes the default view setting for all future videos that this user uploads.

HTTP Status Code Explanation
200 OK

The user was edited.

Edit a user's picture

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

Whether the picture is the user's active portrait.

HTTP Status Code Explanation
200 OK

The picture was edited.

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 array Yes

An array of user URIs for the list of users to follow.

HTTP Status Code Explanation
204 No Content

The users were followed.

401 Unauthorized

The user access token is invalid.

Error Code: 8000

403 Forbidden

The current user cannot follow other users.

Error Code: 3417

400 Bad Request

The request body is empty.

Error Code: 2205

400 Bad Request

The users array is invalid.

Error Code: 2205

400 Bad Request

The list of users does not contain URIs.

Error Code: 2205

400 Bad Request

A user in the list does not exist.

Error Code: 2900

400 Bad Request

The list contains more than 100 users.

Error Code: 2901

500 Internal Server Error

An unexpected error occurred.

Error Code: 4005

429 Too Many Requests

The current user is rate-limited from following other 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

The user was followed.

403 Forbidden

The authenticated user cannot add followers.

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

The user was returned.

Get a user's picture

Check if a user has a picture.

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

The picture was returned.

Get all a user's pictures

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

Get all followers of 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 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 user's followers were returned.

Get all the videos that a user has watched

GET https://api.vimeo.com/me/watched/videos Playground
This method requires a token with the "private" scope.
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 videos were returned.

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 enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • online
No

The filter to apply to 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 followed users were returned.

Get all videos in a user's 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 No

Necessary for proper pagination. Do not provide this value yourself. Instead, use the pagination links in the feed response.

page integer No

The page number to show.

per_page integer No

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

type enum
  • appears
  • category_featured
  • channel
  • facebook_feed
  • following
  • group
  • likes
  • ondemand_publish
  • share
  • tagged_with
  • twitter_timeline
  • uploads
No

The feed type.

HTTP Status Code Explanation
200 OK

The videos were returned.

Search for users

GET https://api.vimeo.com/users 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
  • followers
  • relevant
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The search results were returned.

503 Service Unavailable

Search is disabled.

500 Internal Server Error

There was an internal search error.

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

The user was unfollowed.

Send Feedback