Channels

Add a moderator to a channel

PUT https://api.vimeo.com/channels/{channel_id}/moderators/{user_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

You are not the owner of the channel.

403 Forbidden

The user is already a moderator of the channel.

403 Forbidden

You attempted to add a user that you do not follow.

Add a tag to a channel

PUT https://api.vimeo.com/channels/{channel_id}/tags/{word} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The tag was added.

400 Bad Request

The tag is invalid.

400 Bad Request

A parameter is invalid.

400 Bad Request

The user attempted to add more than 20 tags to a channel.

Error Code: 2501

401 Unauthorized

Invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

The user cannot add tags to this channel.

Error Code: 3200

Add a video to a channel

PUT https://api.vimeo.com/channels/{channel_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 channel was not found.

404 Not Found

If video was not found.

403 Forbidden

The video cannot be added to a channel.

403 Forbidden

The authenticated user is not a moderator of the channel.

Add moderators to a channel

PUT https://api.vimeo.com/channels/{channel_id}/moderators Playground
This method requires a token with the "edit" scope.
Name Type Required Description
user_uri uri Yes

The URI of the user to add as a moderator.

HTTP Status Code Explanation
200 OK

The moderators were added.

400 Bad Request

The list contains more than 100 users.

Error Code: 2908

404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

You are not the owner of the channel.

403 Forbidden

The user is already a moderator of the channel.

403 Forbidden

You tried to add a user that you do not follow.

Add multiple categories to a channel

PUT https://api.vimeo.com/channels/{channel_id}/categories Playground
Name Type Required Description
channels array Yes

The array of category URIs to add.

HTTP Status Code Explanation
204 No Content

The categories were added.

401 Unauthorized

Invalid user credentials were supplied.

Error Code: 8003

404 Not Found

If channel was not found.

403 Forbidden

The user cannot add categories to the channel.

Error Code: 3200

400 Bad Request

There was no request body, or the request body was malformed.

Error Code: 2205

400 Bad Request

The maximum number of channel categories was exceeded.

Error Code: 2204

Add videos to a channel

PUT https://api.vimeo.com/channels/{channel_id}/videos Playground
This method requires a token with the "edit" scope.
Name Type Required Description
video_uri uri Yes

The URI of the video to add.

HTTP Status Code Explanation
200 OK

The videos were added.

404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

The authenticated user is not a moderator of the channel.

403 Forbidden

The video cannot be added to the channel.

Assign multiple tags to a channel

PUT https://api.vimeo.com/channels/{channel_id}/tags Playground
This method requires a token with the "edit" scope.
Name Type Required Description
tag array Yes

An array of tags to assign.

HTTP Status Code Explanation
200 OK

The tags were added.

400 Bad Request

If channel was not found.

400 Bad Request

A parameter is invalid.

400 Bad Request

The user attempted to add more than 20 tags to the channel.

Error Code: 2501

400 Bad Request

There was no request body, or the API could not parse the proper parameters from the request body.

Error Code: 2205

401 Unauthorized

Invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

The user cannot add tags to this channel.

Error Code: 3200

Categorize a channel

PUT https://api.vimeo.com/channels/{channel_id}/categories/{category} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The channel was categorized.

400 Bad Request

The maximum number of channel categories was exceeded.

Error Code: 2204

401 Unauthorized

Invalid user credentials were supplied.

Error Code: 8003

404 Not Found

If channel or category was not found.

403 Forbidden

The authenticated user either does not own the channel or is not a channel moderator.

Error Code: 3200

Check if a tag has been added to a channel

GET https://api.vimeo.com/channels/{channel_id}/tags/{word} Playground
HTTP Status Code Explanation
204 No Content

The tag has been added.

400 Bad Request

If channel was not found in the word.

404 Not Found

The word is valid, but the channel has not been tagged by it.

Error Code: 5000

Check if a user follows a channel

GET https://api.vimeo.com/me/channels/{channel_id} Playground
GET https://api.vimeo.com/users/{user_id}/channels/{channel_id} Playground
HTTP Status Code Explanation
204 No Content

The user follows the channel.

404 Not Found

If channel was not found.

Create a channel

POST https://api.vimeo.com/channels Playground
This method requires a token with the "create" scope.
Name Type Required Description
description string No

The description of the new channel.

link string No

The link to access the channel. You may use a custom name in the URL in place of a numeric channel ID, as in /channels/{url_custom}.

name string Yes

The name of the new channel.

privacy enum
  • anybody
  • moderators
  • user
Yes

The privacy level of the new channel.

HTTP Status Code Explanation
200 OK

The channel was created.

400 Bad Request

A parameter is invalid.

403 Forbidden

The authenticated user cannot create a channel.

Delete a category from a channel

DELETE https://api.vimeo.com/channels/{channel_id}/categories/{category} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The category was deleted.

401 Unauthorized

The user credentials were invalid.

Error Code: 8003

404 Not Found

If channel or category was not found.

403 Forbidden

The authenticated user either does not own the channel or is not a channel moderator.

Error Code: 3200

Delete a channel

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

The channel was deleted.

403 Forbidden

The user does not own this channel.

Delete a tag from a channel

DELETE https://api.vimeo.com/channels/{channel_id}/tags/{word} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

The tag was deleted.

400 Bad Request

The tag is invalid.

400 Bad Request

The parameter is invalid.

401 Unauthorized

The user credentials are invalid.

Error Code: 8003

403 Forbidden

The user cannot delete tags from this channel.

Error Code: 3200

Delete a video from a channel

DELETE https://api.vimeo.com/channels/{channel_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 channel was not found.

404 Not Found

If video was not found.

403 Forbidden

The authenticated user is not a moderator of the channel.

Disallow a user from viewing a private channel

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

The user was disallowed.

401 Unauthorized

The user credentials are invalid.

Error Code: 8003

403 Forbidden

You do not own this channel.

Error Code: 3200

404 Not Found

You cannot add this user to a channel of this type.

Error Code: 2204

Edit a channel

PATCH https://api.vimeo.com/channels/{channel_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
description string No

The description of the channel.

link string No

The link to access the channel. You may use a custom name in the URL in place of a numeric channel ID, as in /channels/{url_custom}. Submitting "" for this field removes the link alias.

name string No

The name of the channel.

privacy enum
  • anybody
  • moderators
  • users
No

The channel's privacy level.

HTTP Status Code Explanation
200 OK

The channel was edited.

400 Bad Request

A parameter is invalid.

Enable a user to view a private channel

PUT https://api.vimeo.com/channels/{channel_id}/privacy/users/{user_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
200 OK

The user can now view the private channel.

401 Unauthorized

The user credentials are invalid.

Error Code: 8003

403 Forbidden

You do not own this channel.

Error Code: 3200

404 Not Found

You cannot add this user to a channel of this type.

Error Code: 2204

Get a channel

GET https://api.vimeo.com/channels/{channel_id} Playground
HTTP Status Code Explanation
200 OK

The channel was returned.

Get a channel's tags

GET https://api.vimeo.com/channels/{channel_id}/tags Playground
HTTP Status Code Explanation
200 OK

The tags were returned.

400 Bad Request

If channel was not found.

Get a video in a channel

Check if this channel contains a video.

GET https://api.vimeo.com/channels/{channel_id}/videos/{video_id} Playground
HTTP Status Code Explanation
200 OK

The video was returned.

404 Not Found

If channel was not found.

Get all categories for a channel

GET https://api.vimeo.com/channels/{channel_id}/categories Playground
HTTP Status Code Explanation
200 OK

The categories were returned.

404 Not Found

If channel was not found.

Get all channel subscriptions for a user

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

The sort direction of the results.

filter enum
  • moderated
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
  • followers
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
304 Not Modified

No channel has been followed since the given If-Modified-Since header.

200 OK

The channels were returned.

Get all channels

GET https://api.vimeo.com/channels Playground
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • featured
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
  • followers
  • relevant
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The channels were returned.

400 Bad Request

The relevant sort has no search query.

Get all channels from which a user can add or remove videos

GET https://api.vimeo.com/videos/{video_id}/available_channels Playground
HTTP Status Code Explanation
200 OK

The channels were returned.

403 Forbidden

The user cannot add or remove this video from any channel.

404 Not Found

The user cannot moderate any channels.

Get all followers of a channel

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

The sort direction of the results.

filter enum
  • moderators
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 followers were returned.

404 Not Found

If channel was not found.

400 Bad Request

The search query does not have the moderators filter. This feature is not yet supported.

Get all moderators for a channel

GET https://api.vimeo.com/channels/{channel_id}/moderators 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 moderators were returned.

Get all users who can view a private channel

GET https://api.vimeo.com/channels/{channel_id}/privacy/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).

HTTP Status Code Explanation
200 OK

The users were returned.

401 Unauthorized

The user credentials are invalid.

Error Code: 8003

403 Forbidden

You do not own this channel.

Error Code: 3200

404 Not Found

You cannot add this user to a channel of this type.

Error Code: 2204

Get all videos in a channel

GET https://api.vimeo.com/channels/{channel_id}/videos Playground
Name Type Required Description
containing_uri uri No

The page that contains 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.

per_page integer No

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

query string No

The search query.

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

The technique for sorting the results.

HTTP Status Code Explanation
304 Not Modified

No videos have been added to this channel since the given If-Modified-Since header.

200 OK

The videos were returned.

404 Not Found

If channel was not found.

400 Bad Request

The sort field is default, but the direction field has a value.

Gets a moderator of a channel

GET https://api.vimeo.com/channels/{channel_id}/moderators/{user_id} Playground
HTTP Status Code Explanation
200 OK

The moderator was returned.

Remove a moderator from a channel

DELETE https://api.vimeo.com/channels/{channel_id}/moderators/{user_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

If you are not the owner of the channel.

403 Forbidden

If the user you are trying to remove is not a moderator of the channel.

403 Forbidden

If you are trying to remove the owner of the channel.

Remove moderators from a channel

DELETE https://api.vimeo.com/channels/{channel_id}/moderators Playground
This method requires a token with the "edit" scope.
Name Type Required Description
user_uri uri Yes

The URI of the user to remove as a moderator

HTTP Status Code Explanation
204 No Content

The moderators were removed.

404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

You do not own this channel.

403 Forbidden

The user is not a moderator of this channel.

403 Forbidden

You cannot remove the owner of the channel.

Remove videos from a channel

DELETE https://api.vimeo.com/channels/{channel_id}/videos Playground
This method requires a token with the "edit" scope.
Name Type Required Description
video_uri uri Yes

The URI of the video to delete.

HTTP Status Code Explanation
204 No Content

The videos were removed.

404 Not Found

If channel was not found.

404 Not Found

If user was not found.

403 Forbidden

The authenticated user is not a moderator of this channel.

403 Forbidden

You cannot remove this video from the channel.

Replace the list of moderators for a channel

PATCH https://api.vimeo.com/channels/{channel_id}/moderators Playground
This method requires a token with the "edit" scope.
Name Type Required Description
user_uri uri Yes

The URI of the user to add.

HTTP Status Code Explanation
200 OK

The moderators were removed.

400 Bad Request

The list contains more than 100 users.

Error Code: 2908

404 Not Found

If channel was not found.

403 Forbidden

You do not own the channel.

Set the users who can view a private channel

PUT https://api.vimeo.com/channels/{channel_id}/privacy/users Playground
This method requires a token with the "edit" scope.
Name Type Required Description
users array Yes

An array of either user URIs or user IDs.

HTTP Status Code Explanation
200 OK

The users were set.

401 Unauthorized

The user credentials are invalid.

Error Code: 8003

403 Forbidden

You do not own this channel.

Error Code: 3200

404 Not Found

You cannot add this user to a channel of this type.

Error Code: 2204

400 Bad Request

There is no request body, or the request body is malformed.

Error Code: 2205

400 Bad Request

A user in the list does not exist.

Error Code: 2900

Subscribe a user to a channel

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

The user was subscribed to the channel.

404 Not Found

If channel was not found.

Unsubscribe a user from a channel

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

The user was unsubscribed to the channel.

404 Not Found

If channel was not found.

Send Feedback