Categories

Check for a video in a category

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

The video belongs to the category.

404 Not Found

If category was not found.

404 Not Found

If video was not found in the category.

Check if a user follows a category

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

The user is following the category.

Get a specific category

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

The category was returned.

404 Not Found

If category was not found.

Get all categories

Get a collection of every top-level category.

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

sort enum
  • last_video_featured_time
  • name
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The categories were returned.

Get all the categories that a user follows

GET https://api.vimeo.com/me/categories Playground
GET https://api.vimeo.com/users/{user_id}/categories Playground
This method requires a token with the "private" scope.
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).

sort enum
  • alphabetical
  • date
  • name
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The categories were returned.

403 Forbidden

You cannot view another user.

Error Code: 3200

Get all the categories to which a video belongs

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

The categories were returned.

404 Not Found

If video was not found.

Get all the channels in a category

GET https://api.vimeo.com/categories/{category}/channels 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
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The channels were returned.

404 Not Found

If category was not found.

Get all the groups in a category

GET https://api.vimeo.com/categories/{category}/groups 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
  • members
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The groups were returned.

404 Not Found

If category was not found.

Get all the videos in a category

GET https://api.vimeo.com/categories/{category}/videos Playground

Subscribe a user to a single category

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

The user was subscribed.

Suggest categories for a video

You may suggest up to two categories and one subcategory for each video. Vimeo makes the final determination about whether the video belongs in these categories.

PUT https://api.vimeo.com/videos/{video_id}/categories Playground
This method requires a token with the "edit" scope.
Name Type Required Description
category array Yes

An array of category names.

HTTP Status Code Explanation
201 Created

The categories were suggested.

404 Not Found

If clip was not found.

404 Not Found

If category was not found.

403 Forbidden

You do not own this video.

Unsubscribe a user from a category

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

The user was unsubscribed.

Send Feedback