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

The video is in pending status.

200 OK

The video was added.

403 Forbidden

The video is already in the group.

403 Forbidden

The user cannot 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

The user has joined the group.

404 Not Found

If group was not found.

404 Not Found

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

The group was created.

403 Forbidden

The authenticated user cannot create groups.

400 Bad Request

A parameter 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

The group was deleted.

403 Forbidden

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

The video was deleted.

403 Forbidden

The authenticated user cannot modify this group's videos.

Get a group

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

The group was returned.

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

The video was returned.

404 Not Found

If group was not found.

404 Not Found

If video was not found in the group.

Get all groups

GET https://api.vimeo.com/groups Playground
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • featured
No

The filter to apply to 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
  • relevant
  • videos
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The groups were returned.

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 enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • moderated
No

The filter to apply to 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.

Get all members of a group

GET https://api.vimeo.com/groups/{group_id}/users Playground
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • moderators
No

The filter to apply to 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
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The members were returned.

404 Not Found

If group was not found.

Get all videos in a group

GET https://api.vimeo.com/groups/{group_id}/videos Playground
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

filter enum
  • embeddable
No

The filter to apply to the results.

filter_embeddable boolean No

Whether to filter by all embeddable videos or by all videos that are not embeddable. *Required only if filter is embeddable.

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
  • comments
  • date
  • duration
  • likes
  • plays
No

The technique for sorting the results.

HTTP Status Code Explanation
304 Not Modified

No videos were added to this group since the given If-Modified-Since header.

200 OK

The videos were returned.

404 Not Found

If group was not 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

The user joined the group.

403 Forbidden

The authenticated user cannot join groups.

403 Forbidden

The group prohibits the authenticated user from joining, either because the group is not public or because the group's 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

The user left the group.

403 Forbidden

The authenticated user owns the group. (To remove this user, first apply a new group owner through PATCH.)

Send Feedback