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 the channel cannot be found.

404 Not Found

If the user cannot be found.

403 Forbidden

If you are not the owner of the channel.

403 Forbidden

If the user is already a moderator of the channel.

403 Forbidden

If you are trying to add a user 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.
Name Type Required Description
tag array Yes

An array of tags to assign.

HTTP Status Code Explanation
204 No Content

400 Bad Request

If the tag is invalid.

400 Bad Request

If an unsupported parameter is supplied.

400 Bad Request

If the user attempts to add more than 20 tags to a channel.

Error Code: 2501

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

If the user is not permitted to 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

404 Not Found

If the channel cannot be found.

404 Not Found

If the video cannot be found.

403 Forbidden

If the video is restricted from being added to channels.

403 Forbidden

If 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 string Yes

URI of the user being added

HTTP Status Code Explanation
200 OK

400 Bad Request

If more than 100 users were supplied in the list.

Error Code: 2908

404 Not Found

If the channel cannot be found.

404 Not Found

If the user cannot be found.

403 Forbidden

If you are not the owner of the channel.

403 Forbidden

If the user is already a moderator of the channel.

403 Forbidden

If you are trying to add a user you do not follow.

Add multiple categories for a channel

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

Array of Category URI's to subscribe to.

HTTP Status Code Explanation
204 No Content

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

404 Not Found

If the channel is not found.

403 Forbidden

If the user is not allowed to add categories to the channel.

Error Code: 3200

400 Bad Request

If no request body was supplied or is malformed.

Error Code: 2205

400 Bad Request

If the maximum amount of channel categories is 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 string Yes

URI of the video being added

HTTP Status Code Explanation
200 OK

404 Not Found

If the channel cannot be found.

404 Not Found

If the user cannot be found.

403 Forbidden

If the authenticated user is not a moderator of the channel.

403 Forbidden

If the video is not permitted to be added to the channel.

Assign many 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

400 Bad Request

If the channel cannot be found.

400 Bad Request

If an unsupported parameter is supplied.

400 Bad Request

If the user attempts to add more than 20 tags to a channel.

Error Code: 2501

400 Bad Request

If no request body was supplied or unable to parse proper params from request body.

Error Code: 2205

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

If the user is not allowed to 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

400 Bad Request

If the maximum amount of channel categories is exceeded.

Error Code: 2204

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

404 Not Found

If the channel or category is not found.

403 Forbidden

If the authenticated user 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

400 Bad Request

If the channel cannot be found in the word.

404 Not Found

If the supplied word is valid, but this channel has not been tagged by said word.

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

404 Not Found

If the channel cannot be 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. May use a custom name in the URL in place of a numeric channel ID. eg. /channels/{url_custom}

name string Yes

The name of the new channel

privacy string
  • anybody
  • moderators
  • user
Yes

The privacy level of the new channel

HTTP Status Code Explanation
200 OK

400 Bad Request

If an invalid parameter is supplied.

403 Forbidden

If the authenticated user can not 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

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

404 Not Found

If the channel or category is not found.

403 Forbidden

If the authenticated user 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

403 Forbidden

If this user is not channel owner.

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

400 Bad Request

If the tag is invalid.

400 Bad Request

If an unsupported parameter is supplied.

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

If the user is not permitted to delete tags to 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

404 Not Found

If the channel cannot be found.

404 Not Found

If the video cannot be found.

403 Forbidden

If 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

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

When trying to alter a channel that you do not own.

Error Code: 3200

404 Not Found

When attempting to add a user for an incompatible channel 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 channel's new description

link string No

The link to access the channel. May use a custom name in the URL in place of a numeric channel ID. eg. /channels/{url_custom}. Submitting "" for this field will remove the link alias.

name string No

The channel's new name

privacy string
  • anybody
  • moderators
  • users
No

The channel's new privacy level

HTTP Status Code Explanation
200 OK

400 Bad Request

If an invalid parameter is supplied.

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

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

When trying to alter a channel that you do not own.

Error Code: 3200

404 Not Found

When attempting to add a user for an incompatible channel type.

Error Code: 2204

Get a channel

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

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

404 Not Found

If the channel cannot be found.

Get all categories for a channel

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

404 Not Found

If the channel is not found.

Get all channels

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

The direction that the results are sorted.

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

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

400 Bad Request

If relevant sort is provided without a search query.

Get all channels a user is subscribed to

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

The direction that the results are sorted.

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

Technique used to sort the results.

HTTP Status Code Explanation
304 Not Modified

If no channel has been followed since the provided If-Modified-Since header.

200 OK

Get all followers of a channel

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

The direction that the results are sorted.

filter string
  • moderators
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

404 Not Found

If the channel cannot be found.

400 Bad Request

If a search query is provided without 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 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 users who can view a private channel

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

HTTP Status Code Explanation
200 OK

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

When trying to alter a channel that you do not own.

Error Code: 3200

404 Not Found

When attempting to add a user for an incompatible channel 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 string No

Given a specific video URI, return a page containing it.

direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • embeddable
No

Filter to apply to the results.

filter_embeddable boolean No

Choose between only videos that are embeddable, and only videos that are not embeddable. Required if filter is 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
  • added
  • alphabetical
  • comments
  • date
  • default
  • duration
  • likes
  • manual
  • modified_time
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
304 Not Modified

If no videos were added to this channel since the provided If-Modified-Since header.

200 OK

404 Not Found

If the channel cannot be found.

400 Bad Request

If a sort direction is provided along with the default sort.

Gets a moderator of a channel

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

List a channel's tags

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

400 Bad Request

If the channel cannot be found.

Manage a list of 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

401 Unauthorized

If invalid user credentials were supplied.

Error Code: 8003

403 Forbidden

When trying to alter a channel that you do not own.

Error Code: 3200

404 Not Found

When attempting to add a user for an incompatible channel type.

Error Code: 2204

400 Bad Request

If no request body was supplied or is malformed.

Error Code: 2205

400 Bad Request

If a user in the supplied list of users does not exist.

Error Code: 2900

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

URI of the user being removed

HTTP Status Code Explanation
204 No Content

404 Not Found

If the channel cannot be found.

404 Not Found

If the user cannot be 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 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 string Yes

URI of the video being deleted

HTTP Status Code Explanation
204 No Content

404 Not Found

If the channel cannot be found.

404 Not Found

If the user cannot be found.

403 Forbidden

If the authenticated user is not a moderator of the channel.

403 Forbidden

If the video is not permitted to be removed from the channel.

Replace 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 string Yes

URI of the user being added

HTTP Status Code Explanation
200 OK

400 Bad Request

If more than 100 users were supplied in the list.

Error Code: 2908

404 Not Found

If the channel cannot be found.

403 Forbidden

If you are not the owner of the channel.

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

404 Not Found

If the channel cannot be 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

404 Not Found

If the channel cannot be found.

Send Feedback