Vimeo

Vimeo integration (Design & Media, Social). Imported from open-connector.

OAuth22 toolshttps://api.vimeo.com

GET

vimeo_get_current_user

Get the authenticated Vimeo user profile.

/me

GET

vimeo_list_user_videos

List videos uploaded by the authenticated user or by a specified Vimeo user.

/{userId}/videos

7 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
query	string	optional	Search query used to filter the user's videos.
sort	string	optional	The way to sort the Vimeo video results.
direction	string	optional	The sort direction for Vimeo video results.
filter	string	optional	The Vimeo video filter to apply.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

GET

vimeo_get_video

Get metadata for a specific Vimeo video.

/videos/{videoId}

1 parameter

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.

PATCH

vimeo_update_video

Update basic metadata for a Vimeo video without uploading or replacing media.

/videos/{videoId}

4 parameters

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.
name	string	optional	The new video title.
description	string	optional	The new video description.
license	string	optional	The Creative Commons license code to apply to the video.

DELETE

vimeo_delete_video

Delete a Vimeo video by ID.

/videos/{videoId}

1 parameter

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.

GET

vimeo_get_video_download_links

Get temporary downloadable file links for a Vimeo video when Vimeo exposes them.

/videos/{videoId}

1 parameter

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.

GET

vimeo_download_video_file

Download one Vimeo video file link and store it in local transit storage.

/videos/{videoId}

4 parameters

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.
quality	string	optional	Select a Vimeo download link with this quality label.
type	string	optional	Select a Vimeo download link with this type or MIME type.
fileName	string	optional	The filename to use for the transit file.

GET

vimeo_list_video_tags

List tags attached to a Vimeo video.

/videos/{videoId}/tags

3 parameters

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

PUT

vimeo_add_video_tags

Add one or more tags to a Vimeo video.

/videos/{videoId}/tags

2 parameters

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.
tags	array	optional	Tag names to add to the Vimeo video.

DELETE

vimeo_delete_video_tag

Remove a tag from a Vimeo video.

/videos/{videoId}/tags/{tag}

2 parameters

Param	Type	Required	Description
videoId	integer	required	The Vimeo video ID.
tag	string	required	The tag word to remove from the Vimeo video.

GET

vimeo_list_showcases

List showcases that belong to the authenticated user or to a specified Vimeo user.

/{userId}/albums

6 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
query	string	optional	Search query used to filter Vimeo showcases.
sort	string	optional	The way to sort the Vimeo showcase results.
direction	string	optional	The sort direction for Vimeo showcase results.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

GET

vimeo_get_showcase

Get metadata for a specific Vimeo showcase.

/{userId}/albums/{showcaseId}

2 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
showcaseId	integer	required	The Vimeo showcase ID.

GET

vimeo_list_showcase_videos

List videos in a Vimeo showcase.

/{userId}/albums/{showcaseId}/videos

6 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
showcaseId	integer	required	The Vimeo showcase ID.
sort	string	optional	The way to sort the Vimeo showcase videos.
direction	string	optional	The sort direction for Vimeo showcase videos.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

PUT

vimeo_add_video_to_showcase

Add a Vimeo video to a showcase.

/{userId}/albums/{showcaseId}/videos/{videoId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
showcaseId	integer	required	The Vimeo showcase ID.
videoId	integer	required	The Vimeo video ID.

DELETE

vimeo_remove_video_from_showcase

Remove a Vimeo video from a showcase.

/{userId}/albums/{showcaseId}/videos/{videoId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
showcaseId	integer	required	The Vimeo showcase ID.
videoId	integer	required	The Vimeo video ID.

GET

vimeo_list_folders

List folders that belong to the authenticated user or to a specified Vimeo user.

/{userId}/projects

6 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
query	string	optional	Search query used to filter Vimeo folders.
sort	string	optional	The way to sort the Vimeo folder results.
direction	string	optional	The sort direction for Vimeo folder results.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

GET

vimeo_get_folder

Get metadata for a Vimeo folder.

/{userId}/projects/{folderId}

2 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.

PATCH

vimeo_update_folder

Update a Vimeo folder name.

/{userId}/projects/{folderId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.
name	string	required	The new folder name.

DELETE

vimeo_delete_folder

Delete a Vimeo folder, optionally deleting the videos inside it.

/{userId}/projects/{folderId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.
shouldDeleteVideos	boolean	optional	Whether Vimeo should also delete videos in the folder.

GET

vimeo_list_folder_videos

List videos in a Vimeo folder.

/{userId}/projects/{folderId}/videos

8 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.
query	string	optional	Search query used to filter videos in the folder.
sort	string	optional	The way to sort the folder video results.
direction	string	optional	The sort direction for folder video results.
includeSubfolders	boolean	optional	Whether Vimeo should include videos from subfolders.
page	integer	optional	The page number of the results to show.
perPage	integer	optional	The number of items to show on each page of results, up to a maximum of 100.

PUT

vimeo_add_video_to_folder

Add a Vimeo video to a folder.

/{userId}/projects/{folderId}/videos/{videoId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.
videoId	integer	required	The Vimeo video ID.

DELETE

vimeo_remove_video_from_folder

Remove a Vimeo video from a folder without deleting the video.

/{userId}/projects/{folderId}/videos/{videoId}

3 parameters

Param	Type	Required	Description
userId	integer	required	The Vimeo user ID. Omit this field to use the authenticated user.
folderId	integer	required	The Vimeo folder ID.
videoId	integer	required	The Vimeo video ID.