api.vimeo.com/groups

Groups

View one group

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

Delete one group

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

403 Forbidden

If the authenticated user is not the Group owner.

View all groups

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

Create a group

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

The description of the new Group

name string Yes

The name of the new Group

HTTP Status Code Explanation
200 OK

403 Forbidden

If the authenticated user is not allowed to create Groups.

400 Bad Request

If one of the parameters is invalid..

Users

View all members

GET https://api.vimeo.com/groups/{group_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 Group cannot be found

Videos

Check for a video

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

404 Not Found

If the Group cannot be found

404 Not Found

If the video cannot be found in the Group

Add a video

PUT https://api.vimeo.com/groups/{group_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
202 Accepted

If the video is in pending status.

204 No Content

403 Forbidden

If the video is already in the group

403 Forbidden

If the user can not add videos to the group.

Remove a video

DELETE https://api.vimeo.com/groups/{group_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If the authenticated user is not allowed to modify this Group's videos.

403 Forbidden

If the video is not allowed to be added to Groups.

View all videos

GET https://api.vimeo.com/groups/{group_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
  • alphabetical
  • comments
  • date
  • duration
  • likes
  • plays
No

Technique used to sort the results.

HTTP Status Code Explanation
304 Not Modified

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

200 OK

404 Not Found

If the Group cannot be found

Send Feedback