Groups

Add a video to a group

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.

Check if user has joined a group

GET https://api.vimeo.com/me/groups/{group_id} Playground
GET https://api.vimeo.com/users/{user_id}/groups/{group_id} Playground
HTTP Status Code Explanation
204 No Content

404 Not Found

If the group cannot be found.

404 Not Found

If the authenticated user is not a member of this group.

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 No

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.

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

Delete a video from a group

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 groups' videos.

403 Forbidden

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

Get a group

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

Get a video in a group

Check if a group has 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.

Get 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
  • relevant
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Get all groups a user has joined

GET https://api.vimeo.com/me/groups Playground
GET https://api.vimeo.com/users/{user_id}/groups 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
  • members
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Get all members of a group

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.

Get all videos in a group

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

Join a group

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

403 Forbidden

If the authenticated user is not allowed to join groups.

403 Forbidden

If the group prohibits the authenticated user from joining (not public, or privacy setting is members).

Leave a group

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

403 Forbidden

If the authenticated user owns the group (a new group owner must be applied first via PATCH).

Send Feedback