Channels

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.

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 Yes

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

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.

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 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
  • 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 videos in a channel

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

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.

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

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
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the channel is not found.

Send Feedback