Categories

Categorize a video

Add up to two categories and a subcategory to a video. This is merely a suggestion, and does not ensure that the video will added to the category.

PUT https://api.vimeo.com/videos/{video_id}/categories Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
201 Created

404 Not Found

If the clip cannot be found.

404 Not Found

If the category cannot be found.

403 Forbidden

If you are attempting to modify an clip you do not own.

Check for a video in a category

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

404 Not Found

If the category cannot be found.

404 Not Found

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

Get a category

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

404 Not Found

If the category cannot be found.

Get all categories

Get a collection of every top-level category.

GET https://api.vimeo.com/categories Playground
Name Type Required Description
direction string 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.

sort string
  • last_video_featured_time
  • name
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Get all categories 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 string 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.

sort string
  • alphabetical
  • date
  • name
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

403 Forbidden

When trying to view another user.

Error Code: 3200

Get all categories a video is in

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

404 Not Found

If the video cannot be found.

Get all channels for a category

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

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the category cannot be found.

Get all groups for a category

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

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the category cannot be found.

Get all videos in a category

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

Subscribe a user to a 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

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

Send Feedback