> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vimeo

> How to set up the Vimeo connector, plus the actions and events that are available.

![Vimeo](https://stackone-logos.com/api/vimeo/filled/svg)

v2.2.0[See changelog](https://docs.stackone.com/connectors/vimeo/changelog.md)

[100 actions](#actions) · [17 events](#events) · 2 auth methods

Media

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/vimeo/guides/connector-profile/oauth-2-0.md)
>
> Requires registering a Vimeo developer app. Uses OAuth 2.0 authorization code flow with granular scopes per resource.

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/vimeo/guides/connector-profile/personal-access-token.md)
>
> Requires creating a Vimeo developer app to generate a Personal Access Token. No OAuth redirect flow needed. Token inheri...

Optionally, configure receiving Events for Vimeo into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/vimeo/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/vimeo/guides/link-account/oauth-2-0.md)

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/vimeo/guides/link-account/personal-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

create

delete

edit

interact

private

public

upload

No scopes found

100 actions

ActionDescriptionRequired scopes

Get Authenticated User`vimeo_get_authenticated_user`

Retrieve the profile of the currently authenticated Vimeo user

`public`

Get User`vimeo_get_user`

Retrieve a user's public profile by their ID

`public`

Edit User`vimeo_edit_user`

Update the authenticated user's profile settings

`edit`

Edit User By ID`vimeo_edit_user_by_id`

Update a specific user's profile settings by their ID

`edit`

Search Users`vimeo_search_users`

Search for users on Vimeo

`public`

List User Followers`vimeo_list_user_followers`

Retrieve all followers of a user

`private`

List User Following`vimeo_list_user_following`

Retrieve all users that a user follows

`private`

Follow User`vimeo_follow_user`

Follow a specific user

`interact`

Unfollow User`vimeo_unfollow_user`

Unfollow a specific user

`interact`

List Embed Presets`vimeo_list_embed_presets`

Retrieve all embed presets for a user

`private`

List Portfolios`vimeo_list_portfolios`

Retrieve all portfolios for a user

`private`

List Watch History`vimeo_list_watch_history`

Retrieve the authenticated user's watch history

`private`

List Videos`vimeo_list_videos`

Retrieve all videos uploaded by the authenticated user

`private`

List User Videos By ID`vimeo_list_user_videos`

Retrieve all videos uploaded by a specific user

`private`

Get Video`vimeo_get_video`

Retrieve a specific video by its ID

`public`

Search Videos`vimeo_search_videos`

Search for public videos on Vimeo

`public`

Update Video`vimeo_update_video`

Update a video's metadata and settings

`edit`

Upload Video`vimeo_upload_video`

Upload a video to the authenticated user's account using a pull URL

`upload`

Upload Video By User ID`vimeo_upload_video_by_user_id`

Upload a video to a specific user's account using a pull URL

`upload`

Delete Video`vimeo_delete_video`

Permanently delete a video

`delete`

Create Folder`vimeo_create_folder`

Create a new folder for the authenticated user

`create`

List Folders`vimeo_list_folders`

Retrieve all folders belonging to the authenticated user

`private`

Get Folder`vimeo_get_folder`

Retrieve a specific folder for the authenticated user's own account

`private`

Update Folder`vimeo_update_folder`

Update a folder's name for the authenticated user's own account

`edit`

Delete Folder`vimeo_delete_folder`

Delete a folder and optionally its contents

`delete`

List Folder Videos`vimeo_list_folder_videos`

Retrieve all videos in a specific folder

`private`

Add Video To Folder`vimeo_add_folder_video`

Add a single video to a folder

`edit`

Remove Video From Folder`vimeo_remove_folder_video`

Remove a single video from a folder

`edit`

Create Folder By User ID`vimeo_create_folder_by_user_id`

Create a new folder for a specific user

`create`

List Folders By User ID`vimeo_list_folders_by_user_id`

Retrieve all folders belonging to a specific user

`private`

Get Folder By User ID`vimeo_get_folder_by_user_id`

Retrieve a specific folder for ANOTHER user (requires their user\_id). For your OWN account use get\_folder instead

`private`

Update Folder By User ID`vimeo_update_folder_by_user_id`

Update a folder's name for ANOTHER user (requires their user\_id). For your OWN account use update\_folder instead

`edit`

Delete Folder By User ID`vimeo_delete_folder_by_user_id`

Delete a folder for a specific user

`delete`

List Folder Videos By User ID`vimeo_list_folder_videos_by_user_id`

Retrieve all videos in a specific folder for a specific user

`private`

Add Video To Folder By User ID`vimeo_add_folder_video_by_user_id`

Add a single video to a folder for a specific user

`edit`

Remove Video From Folder By User ID`vimeo_remove_folder_video_by_user_id`

Remove a single video from a folder for a specific user

`edit`

Create Showcase`vimeo_create_showcase`

Create a new showcase for the authenticated user

`create`

List Showcases`vimeo_list_showcases`

Retrieve all showcases belonging to the authenticated user

`private`

Get Showcase`vimeo_get_showcase`

Retrieve a specific showcase for the authenticated user's own account

`private`

Update Showcase`vimeo_update_showcase`

Update a showcase's settings for the authenticated user's own account

`edit`

Delete Showcase`vimeo_delete_showcase`

Delete a showcase

`delete`

List Showcase Videos`vimeo_list_showcase_videos`

Retrieve all videos in a specific showcase

`private`

Add Video To Showcase`vimeo_add_showcase_video`

Add a specific video to a showcase for the authenticated user's own account

`edit`

Remove Video From Showcase`vimeo_remove_showcase_video`

Remove a video from a showcase

`edit`

Create Showcase By User ID`vimeo_create_showcase_by_user_id`

Create a new showcase for a specific user

`create`

List Showcases By User ID`vimeo_list_showcases_by_user_id`

Retrieve all showcases belonging to a specific user

`private`

Get Showcase By User ID`vimeo_get_showcase_by_user_id`

Retrieve a specific showcase for ANOTHER user (requires their user\_id). For your OWN account use get\_showcase instead

`private`

Update Showcase By User ID`vimeo_update_showcase_by_user_id`

Update a showcase's settings for ANOTHER user (requires their user\_id). For your OWN account use update\_showcase instead

`edit`

Delete Showcase By User ID`vimeo_delete_showcase_by_user_id`

Delete a showcase for a specific user

`delete`

List Showcase Videos By User ID`vimeo_list_showcase_videos_by_user_id`

Retrieve all videos in a specific showcase for a specific user

`private`

Add Video To Showcase By User ID`vimeo_add_showcase_video_by_user_id`

Add a specific video to a showcase for ANOTHER user (requires their user\_id). For your OWN account use add\_showcase\_vide...

`edit`

Remove Video From Showcase By User ID`vimeo_remove_showcase_video_by_user_id`

Remove a video from a showcase for a specific user

`edit`

Create Channel`vimeo_create_channel`

Create a new channel

`create`

List Channels`vimeo_list_channels`

Retrieve all publicly available channels

`public`

Get Channel`vimeo_get_channel`

Retrieve a specific channel by its ID

`public`

Update Channel`vimeo_update_channel`

Update a channel's settings

`edit`

Delete Channel`vimeo_delete_channel`

Delete a channel

`delete`

List Channel Videos`vimeo_list_channel_videos`

Retrieve all videos in a channel

`public`

Add Video To Channel`vimeo_add_video_to_channel`

Add a specific video to a channel

`edit`

List Liked Videos`vimeo_list_user_liked_videos`

Retrieve all videos liked by the authenticated user

`private`

Like Video`vimeo_like_video`

Like a video as the authenticated user

`interact`

Unlike Video`vimeo_unlike_video`

Unlike a video as the authenticated user

`interact`

List Watch Later`vimeo_list_watch_later`

Retrieve all videos in the authenticated user's Watch Later queue

`private`

Add To Watch Later`vimeo_add_to_watch_later`

Add a video to the authenticated user's Watch Later queue

`interact`

Remove From Watch Later`vimeo_remove_from_watch_later`

Remove a video from the authenticated user's Watch Later queue

`interact`

List User Liked Videos By ID`vimeo_list_user_liked_videos_by_id`

Retrieve all videos liked by a specific user

`private`

Like Video By User ID`vimeo_like_video_by_id`

Like a video as a specific user

`interact`

Unlike Video By User ID`vimeo_unlike_video_by_id`

Unlike a video as a specific user

`interact`

List Watch Later By User ID`vimeo_list_watch_later_by_id`

Retrieve all videos in a specific user's Watch Later queue

`private`

Add To Watch Later By User ID`vimeo_add_to_watch_later_by_id`

Add a video to a specific user's Watch Later queue

`interact`

Remove From Watch Later By User ID`vimeo_remove_from_watch_later_by_id`

Remove a video from a specific user's Watch Later queue

`interact`

List Video Comments`vimeo_list_video_comments`

Retrieve all comments on a video

`public`

Add Video Comment`vimeo_add_video_comment`

Add a comment to a video

`interact`

List Video Tags`vimeo_list_video_tags`

Retrieve all tags on a video

`public`

Add Video Tag`vimeo_add_video_tag`

Add a tag to a video

`edit`

Remove Video Tag`vimeo_remove_video_tag`

Remove a tag from a video

`edit`

Get Video Comment`vimeo_get_video_comment`

Retrieve a specific comment on a video

`public`

Edit Video Comment`vimeo_edit_video_comment`

Edit a comment on a video

`edit`

Delete Video Comment`vimeo_delete_video_comment`

Delete a comment from a video

`delete`

List Video Thumbnails`vimeo_list_video_thumbnails`

Retrieve all thumbnails for a video

`public`

Add Video Thumbnail`vimeo_add_video_thumbnail`

Add a custom thumbnail to a video

`upload`

List Comment Replies`vimeo_list_comment_replies`

Retrieve all replies to a comment on a video

`public`

Add Comment Reply`vimeo_add_comment_reply`

Reply to a comment on a video

`interact`

List Video Credits`vimeo_list_video_credits`

Retrieve all credits for a video

`public`

Add Video Credit`vimeo_add_video_credit`

Add a credit to a video

`edit`

List Related Videos`vimeo_list_related_videos`

Retrieve related videos for a video

`public`

List Text Tracks`vimeo_list_text_tracks`

Retrieve all text tracks (captions/subtitles) for a video

`public`

List Text Tracks By Version ID`vimeo_list_text_tracks_by_version_id`

Retrieve all text tracks for a specific version of a video

`public`

List Text Tracks By Channel ID`vimeo_list_text_tracks_by_channel_id`

Retrieve all text tracks for a video in a channel

`public`

List Text Tracks By Album ID`vimeo_list_text_tracks_by_album_id`

Retrieve all text tracks for a video in a showcase/album

`public`

Get Text Track`vimeo_get_text_track`

Retrieve a specific text track from a video

`public`

Create Text Track`vimeo_create_text_track`

Add a text track (captions/subtitles) to a video

`upload`

Create Text Track By Channel ID`vimeo_create_text_track_by_channel_id`

Add a text track (captions/subtitles) to a video in a channel

`upload`

Edit Text Track`vimeo_edit_text_track`

Edit a text track on a video

`edit`

Delete Text Track`vimeo_delete_text_track`

Delete a text track from a video

`delete`

List Content Ratings`vimeo_list_content_ratings`

Retrieve all available content ratings

`public`

List Categories`vimeo_list_categories`

Retrieve all video categories

`public`

List Groups`vimeo_list_groups`

Retrieve all groups

`public`

Get Languages`vimeo_get_languages`

Retrieve all supported languages

`public`

Get Creative Commons Licenses`vimeo_get_cc_licenses`

Retrieve all Creative Commons licenses

`public`

## Events

Tags

Select all
|
Clear

Live Events

Registrations

Videos

Webhooks

No tags found

17 events

EventDescriptionTags

Video Created Webhook`vimeo_webhook_video_created`

Processes Vimeo video-created webhook events.

VideosWebhooks

Video Deleted Webhook`vimeo_webhook_video_deleted`

Processes Vimeo video-deleted webhook events.

VideosWebhooks

Video Upload Failed Webhook`vimeo_webhook_video_upload_failed`

Processes Vimeo video-upload-failed webhook events.

VideosWebhooks

Video Transcode Playable Webhook`vimeo_webhook_video_transcode_playable`

Processes Vimeo video-transcode-playable webhook events.

VideosWebhooks

Video Transcode Fully Playable Webhook`vimeo_webhook_video_transcode_fully_playable`

Processes Vimeo video-transcode-fully-playable webhook events.

VideosWebhooks

Video Transcode Complete Webhook`vimeo_webhook_video_transcode_complete`

Processes Vimeo video-transcode-complete webhook events.

VideosWebhooks

Transcript Status Complete Webhook`vimeo_webhook_transcript_status_complete`

Processes Vimeo transcript-status-complete webhook events.

VideosWebhooks

Automatic Thumbnail Available Webhook`vimeo_webhook_automatic_thumbnail_available`

Processes Vimeo automatic-thumbnail-available webhook events.

VideosWebhooks

Content Scan Completed Webhook`vimeo_webhook_content_scan_completed`

Processes Vimeo content-scan-completed webhook events.

VideosWebhooks

Live Event Started Webhook`vimeo_webhook_live_event_started`

Processes Vimeo live-event-started webhook events.

Live EventsWebhooks

Live Event Ended Webhook`vimeo_webhook_live_event_ended`

Processes Vimeo live-event-ended webhook events.

Live EventsWebhooks

Live Event Updated Webhook`vimeo_webhook_live_event_updated`

Processes Vimeo live-event-updated webhook events.

Live EventsWebhooks

Live Event Clip Created Webhook`vimeo_webhook_live_event_clip_created`

Processes Vimeo live-event-clip-created webhook events.

Live EventsWebhooks

Live Event Archive Available Webhook`vimeo_webhook_live_event_archive_available`

Processes Vimeo live-event-archive-available webhook events.

Live EventsWebhooks

Registration Created Webhook`vimeo_webhook_registration_created`

Processes Vimeo registration-created webhook events.

RegistrationsWebhooks

Registration Updated Webhook`vimeo_webhook_registration_updated`

Processes Vimeo registration-updated webhook events.

RegistrationsWebhooks

Registration Deleted Webhook`vimeo_webhook_registration_deleted`

Processes Vimeo registration-deleted webhook events.

RegistrationsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.