# Vimeo API API

> Vimeo API API on Apizie: 400 endpoints (Get the API specification, Get all the user's videos that can be added to or removed from a showcase, Get all categories, Get a specific category, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/entertainment:vimeo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `entertainment:vimeo`
- Category: Entertainment
- Status: byok
- Source: https://developer.vimeo.com
- Page: https://apizie.tech/api/entertainment/vimeo
- OpenAPI: https://apizie.tech/api/entertainment/vimeo/openapi.json

Build something great. Vimeo's API supports flexible, high-quality video integration with your custom apps.

## Endpoints

### Get the API specification
`GET https://apizie.tech/v1/entertainment:vimeo/get-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| openapi | boolean | no | Return an OpenAPI specification. |
| version | string | no | Return an OpenAPI specification for the specified API version. This overwrites the **version** field provided in the **Accept** header. |

### Get all the user's videos that can be added to or removed from a showcase
`GET https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-list-in-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `comments` - Sort the results by… |

### Get all categories
`GET https://apizie.tech/v1/entertainment:vimeo/get-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| sort | string | no | The way to sort the results. |

### Get a specific category
`GET https://apizie.tech/v1/entertainment:vimeo/get-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |

### Get all the channels in a category
`GET https://apizie.tech/v1/entertainment:vimeo/categories-channels-list-in-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date.… |

### Get all the groups in a category
`GET https://apizie.tech/v1/entertainment:vimeo/categories-groups-get-all-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date.… |

### Get all the videos in a category
`GET https://apizie.tech/v1/entertainment:vimeo/categories-videos-list-videos-in-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `conditional_featured` - Return featured videos. * `embeddable` -… |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `comments` - Sort the results by… |

### Get a specific video in a category
`GET https://apizie.tech/v1/entertainment:vimeo/categories-videos-get-video-in-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| video_id | number | yes | The ID of the video. |

### Get all channels
`GET https://apizie.tech/v1/entertainment:vimeo/get-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `featured` - Return featured channels. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |

### Create a channel
`POST https://apizie.tech/v1/entertainment:vimeo/create-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a specific channel
`GET https://apizie.tech/v1/entertainment:vimeo/get-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Edit a channel
`POST https://apizie.tech/v1/entertainment:vimeo/edit-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | no | JSON request body |

### Delete a channel
`POST https://apizie.tech/v1/entertainment:vimeo/delete-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Get all the categories to which a channel belongs
`GET https://apizie.tech/v1/entertainment:vimeo/channels-categories-get-belonging-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Add a channel to a list of categories
`POST https://apizie.tech/v1/entertainment:vimeo/channels-categories-add-channel-to-multiple-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Add a channel to a specific category
`POST https://apizie.tech/v1/entertainment:vimeo/categorize-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| channel_id | number | yes | The ID of the channel. |

### Remove a channel from a category
`POST https://apizie.tech/v1/entertainment:vimeo/channels-categories-remove-channel-from-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |
| channel_id | number | yes | The ID of the channel. |

### Get all the moderators of a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-moderators-list-by-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date… |

### Add a list of moderators to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-moderators-bulk-add-moderators` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Replace the moderators of a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-moderators-replace-moderators` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Remove a list of moderators from a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-moderators-remove-multiple-from-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Get a specific moderator of a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-moderators-get-specific-moderator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| user_id | number | yes | The ID of the user. |

### Add a specific moderator to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-moderators-add-moderator-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| user_id | number | yes | The ID of the user. |

### Remove a specific moderator from a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-moderators-remove-moderator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| user_id | number | yes | The ID of the user. |

### Get all the users who can access a private channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-private-channel-members-get-accessible-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Permit a list of users to access a private channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-private-channel-members-permit-user-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Permit a specific user to access a private channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-private-channel-members-permit-user-access-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| user_id | number | yes | The ID of the user. |

### Restrict a user from accessing a private channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-private-channel-members-restrict-user-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| user_id | number | yes | The ID of the user. |

### Get all the tags that have been added to a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-tags-get-all-channel-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Add a list of tags to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-tags-add-multiple-tags-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Check if a tag has been added to a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-tags-check-if-tag-added-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| word | string | yes | The word to use as the tag. |

### Add a specific tag to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-tags-add-tag-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| word | string | yes | The word to use as the tag. |

### Remove a tag from a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-tags-remove-tag-from-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| word | string | yes | The word to use as the tag. |

### Get all the followers of a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-subscriptions-and-subscribers-list-channel-follower` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | yes | The attribute by which to filter the results. Option descriptions: * `moderators` - Return moderators. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |

### Get all the videos in a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-videos-list-in-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| containing_uri | string | no | The page that contains the video URI. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `embeddable` - Return embeddable videos. |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `added` - Sort the results by date added. * `alphabetical` - Sort the results… |

### Add a list of videos to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-videos-add-multiple-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Remove a list of videos from a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-videos-remove-multiple-from-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| body | object | yes | JSON request body |

### Get a specific video in a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-videos-get-specific-video-in-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |

### Add a specific video to a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-videos-add-video-to-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |

### Remove a specific video from a channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-videos-remove-specific-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |

### Get all the video comments on a video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-video-comments-get-all-replies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Add a video comment to a video
`POST https://apizie.tech/v1/entertainment:vimeo/videos-video-comments-add-new-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| body | object | yes | JSON request body |

### Get all the credited users in a video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-credits-get-all-credited-users-in-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date. |

### Credit a user in a video
`POST https://apizie.tech/v1/entertainment:vimeo/videos-credits-add-user-credit-in-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| body | object | yes | JSON request body |

### Get all the users who have liked a video
`GET https://apizie.tech/v1/entertainment:vimeo/likes-essentials-get-users-who-liked-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by join… |

### Get all the thumbnails of a video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-thumbnails-get-all-by-video-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Add a video thumbnail
`POST https://apizie.tech/v1/entertainment:vimeo/videos-thumbnails-add-thumbnail-to-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| body | object | no | JSON request body |

### Get the users who can access an unlisted video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-unlisted-videos-list-accessible-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Permit a list of users to access an unlisted video
`POST https://apizie.tech/v1/entertainment:vimeo/videos-unlisted-videos-grant-access-to-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |

### Get all the text tracks of a video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-text-tracks-get-all-tracks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Add a text track to a video
`POST https://apizie.tech/v1/entertainment:vimeo/videos-text-tracks-add-text-track-to-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| body | object | yes | JSON request body |

### Get all the versions of a video
`GET https://apizie.tech/v1/entertainment:vimeo/videos-versions-get-all-video-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |
| video_id | number | yes | The ID of the video. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Get all content ratings
`GET https://apizie.tech/v1/entertainment:vimeo/videos-content-ratings-get-all-content-ratings` (byok)

### Get all Creative Commons licenses
`GET https://apizie.tech/v1/entertainment:vimeo/videos-creative-commons-get-all-cclicenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Get a live event destination
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-destinations-get-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| destination_id | number | yes | The ID of the event destination. |

### Update a live event destination
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-destinations-update-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| destination_id | number | yes | The ID of the event destination. |
| body | object | no | JSON request body |

### Delete a live event destination
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-destinations-delete-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| destination_id | number | yes | The ID of the event destination. |

### Get all groups
`GET https://apizie.tech/v1/entertainment:vimeo/get-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `featured` - Return featured groups. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |

### Create a group
`POST https://apizie.tech/v1/entertainment:vimeo/create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a specific group
`GET https://apizie.tech/v1/entertainment:vimeo/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |

### Delete a group
`POST https://apizie.tech/v1/entertainment:vimeo/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |

### Get all the members of a group
`GET https://apizie.tech/v1/entertainment:vimeo/groups-users-get-group-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `moderators` - Return group moderators. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |

### Get all the videos in a group
`GET https://apizie.tech/v1/entertainment:vimeo/groups-videos-get-all-group-videos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `embeddable` - Return embeddable videos. |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `comments` - Sort the results by… |

### Get a specific video in a group
`GET https://apizie.tech/v1/entertainment:vimeo/groups-videos-get-single-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |
| video_id | number | yes | The ID of the video. |

### Add a video to a group
`POST https://apizie.tech/v1/entertainment:vimeo/groups-videos-add-to-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |
| video_id | number | yes | The ID of the video. |

### Remove a video from a group
`POST https://apizie.tech/v1/entertainment:vimeo/groups-videos-remove-from-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | number | yes | The ID of the group. |
| video_id | number | yes | The ID of the video. |

### Get all languages
`GET https://apizie.tech/v1/entertainment:vimeo/get-languages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `audiotracks` - Return languages that can be used for audio tracks. *… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |

### Get all the live events that belong to the user
`GET https://apizie.tech/v1/entertainment:vimeo/live-essentials-get-user-live-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `not_in_folder` - Show only events that aren't in a folder. *… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |
| type | string | no | The type of event to return. Option descriptions: * `all` - Return all events. * `one_time` - Return one-time events only. * `recurring` -… |

### Create a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-essentials-create-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete a list of live events
`POST https://apizie.tech/v1/entertainment:vimeo/live-essentials-delete-multiple-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a specific live event
`GET https://apizie.tech/v1/entertainment:vimeo/live-essentials-get-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| password | string | no | The password of the event when the privacy is set to `password`. |

### Update a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-essentials-update-event-belonging-to-authenticated-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Delete a specific live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-essentials-delete-specific-live-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |

### Activate a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-activation-create-rtmp-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Edit the automated closed captions preference of a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-automated-closed-captions-edit-preference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | yes | JSON request body |

### End a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-end-event-termination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| clip_id | number | no | The ID of the streamable video. |

### Toggle the low-latency option of a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-low-latency-toggle-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Get all the thumbnails of a live event
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-thumbnails-get-all-thumbnails` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |

### Create a live event thumbnail
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-thumbnails-create-thumbnail-for-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Get a specific live event thumbnail
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-thumbnails-get-specific-thumbnail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| thumbnail_id | number | yes | The ID of the thumbnail. |

### Edit a live event thumbnail
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-thumbnails-edit-live-event-thumbnail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| thumbnail_id | number | yes | The ID of the thumbnail. |
| body | object | no | JSON request body |

### Delete a live event thumbnail
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-thumbnails-delete-thumbnail-for-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| thumbnail_id | number | yes | The ID of the thumbnail. |

### Get all the domains on which a live event can be embedded
`GET https://apizie.tech/v1/entertainment:vimeo/live-embed-privacy-get-whitelist-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |

### Embed a live event on one or more domains
`POST https://apizie.tech/v1/entertainment:vimeo/live-embed-privacy-embed-event-on-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Get all the videos in a live event
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-videos-list-live-event-videos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| containing_uri | string | no | The page that contains the video URI. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `embeddable` - Return embeddable events. |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `added` - Sort the results by most recently added videos. * `alphabetical` - Sort the… |

### Add a list of videos to a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-videos-add-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Remove a list of videos from a live event
`POST https://apizie.tech/v1/entertainment:vimeo/live-event-videos-remove-multiple-videos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| body | object | no | JSON request body |

### Get a specific video in a live event
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-videos-specific-event-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| live_event_id | number | yes | The ID of the event. |
| video_id | number | yes | The ID of the video. |

### Get the user
`GET https://apizie.tech/v1/entertainment:vimeo/users-essentials-get-user` (byok)

### Edit the user
`POST https://apizie.tech/v1/entertainment:vimeo/users-essentials-edit-vimeo-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get all the showcases that belong to the user
`GET https://apizie.tech/v1/entertainment:vimeo/showcases-essentials-get-all-user-showcases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date… |

### Create a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-essentials-create-user-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a specific showcase
`GET https://apizie.tech/v1/entertainment:vimeo/showcases-essentials-get-specific-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |

### Edit a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-essentials-edit-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| body | object | no | JSON request body |

### Delete a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-essentials-delete-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |

### Get all the videos in a showcase
`GET https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-list-in-showcase-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| containing_uri | string | no | The page containing the video URI. |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `embeddable` - Filter the results by the **embeddable** attribute. |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| password | string | no | The password of the showcase. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `comments` - Sort the results by… |
| weak_search | boolean | no | Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service… |

### Replace all the videos in a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-replace-videos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| body | object | yes | JSON request body |

### Get a specific video in a showcase
`GET https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-get-specific-video-in-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| video_id | number | yes | The ID of the video. |
| password | string | no | The password of the showcase. |

### Add a specific video to a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-add-to-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| video_id | number | yes | The ID of the video. |

### Remove a video from a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-remove-from-showcase` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| video_id | number | yes | The ID of the video. |

### Create a thumbnail for a showcase from a showcase video
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-create-showcase-thumbnail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| video_id | number | yes | The ID of the video. |
| body | object | no | JSON request body |

### Set the featured video of a showcase
`POST https://apizie.tech/v1/entertainment:vimeo/showcases-showcase-videos-set-featured-video` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| album_id | number | yes | The ID of the showcase. |
| video_id | number | yes | The ID of the video. |

### Get analytics for the user
`GET https://apizie.tech/v1/entertainment:vimeo/users-analytics-get-user-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dimension | string | yes | The data dimension by which to group the results. Option descriptions: * `country` - Group the results by country. * `device_type` - Group… |
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter_content | string | no | A comma-separated list of video, folder, or event URIs to filter. |
| filter_countries | array | no | A comma-separated list of country codes in ISO-3166 format to filter on. |
| filter_device_types | array | no | A comma-separated list of device types to filter on. |
| filter_embed_domains | array | no | A comma-separated list of domain names to filter on. |
| filter_streaming_types | array | no | A comma-separated list of streaming types to filter on. |
| from | string | yes | The start date of the range of results in ISO 8601 format. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The maximum number of items returned from the request, up to a limit of 1000 items. The default value is `50`. |
| sort | string | no | The way to sort the results. Option descriptions: * `average_percent_watched` - Sort the results by mean seconds played. *… |
| time_interval | string | no | The interval by which to aggregate the data according to the specified data dimension. The default value is `none`. Option descriptions: *… |
| to | string | yes | The end date of the range of results in ISO 8601 format. |

### Get all the videos in which the user appears
`GET https://apizie.tech/v1/entertainment:vimeo/videos-essentials-get-user-appearances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `embeddable` - Return embeddable videos. |
| filter_embeddable | boolean | no | Whether to filter the results by embeddable videos (`true`) or non-embeddable videos (`false`). This parameter is required only when… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `comments` - Sort the results by… |

### Get all the categories that the user follows
`GET https://apizie.tech/v1/entertainment:vimeo/categories-users-list-followed-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date.… |

### Check if the user follows a category
`GET https://apizie.tech/v1/entertainment:vimeo/categories-users-check-followed-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |

### Cause the user to follow a specific category
`POST https://apizie.tech/v1/entertainment:vimeo/categories-users-follow-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | number | yes | The name of the category. |

### Cause the user to stop following a category
`POST https://apizie.tech/v1/entertainment:vimeo/categories-users-stop-following-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | yes | The name of the category. |

### Get all the channels to which a user subscribes
`GET https://apizie.tech/v1/entertainment:vimeo/channels-essentials-get-user-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `moderated` - Return moderated channels. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by… |

### Check if a user follows a channel
`GET https://apizie.tech/v1/entertainment:vimeo/channels-subscriptions-and-subscribers-check-if-user-follows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Subscribe the user to a specific channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-subscriptions-and-subscribers-subscribe-user-to-cha` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Unsubscribe the user from a specific channel
`POST https://apizie.tech/v1/entertainment:vimeo/channels-subscriptions-and-subscribers-unsubscribe-user-from` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | number | yes | The ID of the channel. |

### Get all the custom logos that belong to the user
`GET https://apizie.tech/v1/entertainment:vimeo/embed-presets-custom-logos-list` (byok)

### Add a custom user logo
`POST https://apizie.tech/v1/entertainment:vimeo/embed-presets-custom-logos-add-user-logo` (byok)

### Get a specific custom user logo
`GET https://apizie.tech/v1/entertainment:vimeo/embed-presets-custom-logos-get-specific-user-logo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| logo_id | number | yes | The ID of the custom logo. |

### Delete a custom user logo
`POST https://apizie.tech/v1/entertainment:vimeo/embed-presets-custom-logos-delete-user-logo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| logo_id | number | yes | The ID of the custom logo. |

### Get all available live event destinations for the user to stream to
`GET https://apizie.tech/v1/entertainment:vimeo/live-event-destinations-get-all-available-destinations` (byok)

### Get all the videos in the user's feed
`GET https://apizie.tech/v1/entertainment:vimeo/users-feeds-get-user-feed-videos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | string | no | The pagination offset. We recommend that you use the pagination links in the feed response instead of working with this value directly.… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| type | string | no | The feed type. Option descriptions: * `appears` - Videos in which the user appears. * `category_featured` - Featured videos. * `channel` -… |

### Get all the followers of the user
`GET https://apizie.tech/v1/entertainment:vimeo/users-followers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date… |

### Get all the users that the user is following
`GET https://apizie.tech/v1/entertainment:vimeo/users-followers-list-of-following-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| direction | string | no | The sort direction of the results. Option descriptions: * `asc` - Sort the results in ascending order. * `desc` - Sort the results in… |
| filter | string | no | The attribute by which to filter the results. Option descriptions: * `online` - Return users who are currently online. |
| page | number | no | The page number of the results to show. |
| per_page | number | no | The number of items to show on each page of results, up to a maximum of 100. |
| query | string | no | The search query to use to filter the results. |
| sort | string | no | The way to sort the results. Option descriptions: * `alphabetical` - Sort the results alphabetically. * `date` - Sort the results by date… |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/entertainment:vimeo/get-endpoints" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Vimeo API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/entertainment:vimeo/get-endpoints with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Vimeo API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Vimeo API itself also needs your own key from api.vimeo.com.

### Can AI agents use the Vimeo API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key entertainment:vimeo.

### What is the status of the Vimeo API API?
Needs your own provider key (bring your own key)