---
canonical_url: "https://docs.composio.dev/toolkits/vimeo"
markdown_url: "https://docs.composio.dev/toolkits/vimeo.md"
product: "platform"
version: null
last_updated: null
---

# Vimeo

Vimeo is a video platform for hosting, managing, sharing, and interacting with video content and account resources.

- **Category:** video & audio
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 50
- **Triggers:** 0
- **Slug:** `VIMEO`
- **Version:** 00000000_00

## Tools

### Get Category

**Slug:** `VIMEO_GET_CATEGORY`

Get one public Vimeo category by slug.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | Yes | The name (slug) of the category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Channel

**Slug:** `VIMEO_GET_CHANNEL`

Get one public Vimeo channel by numeric ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sizes` | string | No | Image dimensions in {width}x{height} format. |
| `channel_id` | integer | Yes | The numeric ID of the channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `VIMEO_GET_CURRENT_USER`

Return the connected Vimeo user's numeric user ID, profile, account tier, capabilities, and resource counts. Use the ID with user-subject tools for self workflows.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `VIMEO_GET_GROUP`

Get one public Vimeo group by numeric ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | The numeric ID of the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On Demand Genre

**Slug:** `VIMEO_GET_ON_DEMAND_GENRE`

Get one public Vimeo On Demand genre by ID. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `genre_id` | string | Yes | The ID of the On Demand genre. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On Demand Region

**Slug:** `VIMEO_GET_ON_DEMAND_REGION`

Get one public Vimeo On Demand catalog region by country code. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Country code from LIST_ON_DEMAND_REGIONS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On Demand Season

**Slug:** `VIMEO_GET_ON_DEMAND_SEASON`

Get one season of a public Vimeo On Demand title. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `season_id` | integer | Yes | The ID of the season. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On Demand Title

**Slug:** `VIMEO_GET_ON_DEMAND_TITLE`

Get one public Vimeo On Demand title. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tag

**Slug:** `VIMEO_GET_TAG`

Get one public Vimeo tag by word.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `word` | string | Yes | The tag to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `VIMEO_GET_USER`

Get one public Vimeo user profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | Numeric Vimeo user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video

**Slug:** `VIMEO_GET_VIDEO`

Return metadata only for a public Vimeo video whose privacy.view is 'anybody'. Private, password-protected, team-only, unlisted, and otherwise restricted IDs are treated as inaccessible even when the connected token can view them; use LIST_MY_VIDEOS for the connected user's private videos.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | integer | Yes | Numeric Vimeo video ID; do not pass the full /videos/... URI. |
| `time_links` | boolean | No | Whether timestamps in the video description should be returned as links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories

**Slug:** `VIMEO_LIST_CATEGORIES`

Return one sortable page of Vimeo's public video categories for discovering category slugs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("last_video_featured_time" | "name") | No | Field used to sort categories. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Maximum categories to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Category Channels

**Slug:** `VIMEO_LIST_CATEGORY_CHANNELS`

Return one page of public channels assigned to a Vimeo category. Vimeo currently returns an internal error for search queries containing apostrophes; no escaping is applied. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "followers" | "videos") | No | Way to sort the channels. |
| `query` | string | No | Search query used to filter channels. Vimeo currently returns an internal error for queries containing apostrophes. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `category` | string | Yes | The name (slug) of the category. |
| `per_page` | integer | No | Number of channels to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Category Groups

**Slug:** `VIMEO_LIST_CATEGORY_GROUPS`

Return one page of public groups assigned to a Vimeo category. A search query must contain at least one letter or digit. Vimeo currently returns an internal error for queries containing apostrophes; no escaping is applied. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "members" | "videos") | No | Way to sort the groups. |
| `query` | string | No | Search query used to filter groups. When supplied, it must contain at least one Unicode letter or digit. Vimeo currently returns an internal error for queries containing apostrophes. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `category` | string | Yes | The name (slug) of the category. |
| `per_page` | integer | No | Number of groups to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Category Videos

**Slug:** `VIMEO_LIST_CATEGORY_VIDEOS`

Return one sortable, filterable page of public videos in a Vimeo category. Vimeo's category-video endpoint currently fails non-empty search queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "comments" | "date" | "duration" | "featured" | "likes" | "plays" | "relevant") | No | Optional field used to sort category videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string ("conditional_featured" | "embeddable") | No | Optional category-video filter. |
| `category` | string | Yes | Category slug from LIST_CATEGORIES, such as animation; do not pass the full /categories/... URI. |
| `per_page` | integer | No | Maximum videos to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `filter_embeddable` | boolean | No | When filter is embeddable, choose embeddable true or non-embeddable false videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channel Categories

**Slug:** `VIMEO_LIST_CHANNEL_CATEGORIES`

List categories assigned to a public Vimeo channel. Vimeo returns the full relation; limit trims the returned data client-side and does not reduce provider data transfer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum categories to return (1-100). Default: 10. |
| `channel_id` | integer | Yes | The numeric ID of the channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channel Followers

**Slug:** `VIMEO_LIST_CHANNEL_FOLLOWERS`

Return one page of followers of a public Vimeo channel. This is distinct from channel moderators. Vimeo supports sorting and pagination for this follower list, but not search. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Way to sort the followers. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `per_page` | integer | No | Number of followers to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `channel_id` | integer | Yes | The numeric ID of the channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channel Moderators

**Slug:** `VIMEO_LIST_CHANNEL_MODERATORS`

Return one page of moderators of a public Vimeo channel. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Way to sort the moderators. |
| `query` | string | No | Search query used to filter moderators. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `per_page` | integer | No | Number of moderators to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `channel_id` | integer | Yes | The numeric ID of the channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channels

**Slug:** `VIMEO_LIST_CHANNELS`

Return one searchable, sortable page of Vimeo's public curated channels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "default" | "followers" | "relevant" | "videos") | No | Optional channel sort; default uses creation date and relevant requires query. |
| `query` | string | No | Search text used to filter channels. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Maximum channels to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `featured_only` | boolean | No | When true, return only featured channels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channel Tags

**Slug:** `VIMEO_LIST_CHANNEL_TAGS`

List tags assigned to a public Vimeo channel. Vimeo returns the full relation; limit trims the returned data client-side and does not reduce provider data transfer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum tags to return (1-100). Default: 10. |
| `channel_id` | integer | Yes | The numeric ID of the channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channel Videos

**Slug:** `VIMEO_LIST_CHANNEL_VIDEOS`

Return one searchable, sortable page of public videos in a Vimeo channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("added" | "alphabetical" | "comments" | "date" | "default" | "duration" | "likes" | "manual" | "modified_time" | "plays") | No | Field used to sort channel videos. |
| `query` | string | No | Search text used to filter videos in the channel. |
| `sizes` | string | No | Requested image dimensions in {width}x{height} format, such as 100x75. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Maximum videos to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional sort direction. Omit this field when sort is default; use asc or desc with other sort modes. |
| `channel_id` | integer | Yes | Numeric channel ID from LIST_CHANNELS; do not pass the full /channels/... URI. |
| `embeddable` | boolean | No | When set, return embeddable true or non-embeddable false videos. |
| `containing_uri` | string | No | Vimeo page URI that contains a video to locate in the channel results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Logos

**Slug:** `VIMEO_LIST_CUSTOM_LOGOS`

Return one page of custom player logos owned by the connected Vimeo user. Custom logos depend on the Standard or Advanced Embed Presets feature; a Free account may return a successful empty list. Pass next_cursor as cursor to fetch the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sizes` | string | No | Pixel dimensions in {width}x{height} format for returned logo images. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Number of custom logos to return per page, up to 100. Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Embed Presets

**Slug:** `VIMEO_LIST_EMBED_PRESETS`

Return one page of embed presets for the connected Vimeo user, or for the Vimeo user selected by optional user_id. Embed presets depend on the Standard or Advanced Embed Presets feature; a Free account may return a successful empty list. Pass next_cursor as cursor to fetch the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `user_id` | integer | No | Numeric Vimeo user ID whose embed presets to list; omit for the connected user. |
| `per_page` | integer | No | Number of embed presets to return per page, up to 100. Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Folders

**Slug:** `VIMEO_LIST_FOLDERS`

Return one page of folders owned by the connected Vimeo user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Maximum folders to return in this page (1-100). Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Members

**Slug:** `VIMEO_LIST_GROUP_MEMBERS`

Return one page of members of a public Vimeo group. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Way to sort the members. |
| `query` | string | No | Search query used to filter members. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `filter` | string | No | Return only group moderators when set. |
| `group_id` | integer | Yes | The numeric ID of the group. |
| `per_page` | integer | No | Number of members to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `VIMEO_LIST_GROUPS`

Return one page of searchable, sortable public Vimeo groups. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "followers" | "relevant" | "videos") | No | Way to sort the groups; relevant requires a non-empty query. |
| `query` | string | No | Search query used to filter groups. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `filter` | string | No | Return featured groups when set. |
| `per_page` | integer | No | Number of groups to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Group Videos

**Slug:** `VIMEO_LIST_GROUP_VIDEOS`

Return one page of public videos in a Vimeo group. Pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "comments" | "date" | "duration" | "likes" | "plays") | No | Way to sort the videos. |
| `query` | string | No | Search query used to filter videos. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `filter` | string | No | Filter by embeddability when set. |
| `group_id` | integer | Yes | The numeric ID of the group. |
| `per_page` | integer | No | Number of videos to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `filter_embeddable` | boolean | No | Whether to return embeddable or non-embeddable videos; required with filter=embeddable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List My Videos

**Slug:** `VIMEO_LIST_MY_VIDEOS`

Return one searchable, sortable page of videos uploaded by the connected Vimeo user, including private videos visible to the grant. Use next_cursor to retrieve the next page. Vimeo's deprecated include_team_content input is intentionally omitted; use filter_uploader to narrow team-visible results to a team member or owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "default" | "duration" | "last_user_action_event_date" | "likes" | "modified_time" | "plays") | No | Field used to sort the videos. |
| `query` | string | No | Search text used to filter the connected user's videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string ("app_only" | "cold_privacy" | "cold_storage" | "embeddable" | "featured" | "live" | "no_placeholder" | "nolive" | "playable" | "screen_recorded") | No | Optional Vimeo video filter. |
| `per_page` | integer | No | Maximum videos to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction; this must be desc when sort is likes or plays. |
| `filter_tag` | string | No | Comma-separated tags; matching videos include at least one tag. |
| `query_fields` | array | No | Fields searched by query: chapters, description, tags, or title. |
| `containing_uri` | string | No | Vimeo page URI containing the video; this cannot be paired with query. |
| `filter_playable` | boolean | No | Choose playable true or non-playable false videos. |
| `filter_uploader` | integer | No | Numeric team member or team owner uploader ID. Use this to narrow team-visible results by uploader; Vimeo's include_team_content input is deprecated and intentionally not exposed. |
| `filter_embeddable` | boolean | No | When filter is embeddable, choose embeddable true or non-embeddable false videos. |
| `filter_tag_all_of` | string | No | Comma-separated tags; matching videos include every tag. |
| `filter_tag_exclude` | string | No | Comma-separated tags that every matching video must exclude. |
| `filter_screen_recorded` | boolean | No | Choose screen-recorded true or non-screen-recorded false videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Genres

**Slug:** `VIMEO_LIST_ON_DEMAND_GENRES`

List Vimeo On Demand catalog genres. Vimeo returns the full catalog; limit trims the returned data client-side and does not reduce provider data transfer. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum genres to return (1-100). Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Posters

**Slug:** `VIMEO_LIST_ON_DEMAND_POSTERS`

List one page of poster artwork for a public Vimeo On Demand title and return next_cursor. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `per_page` | integer | No | Maximum posters to return (1-100). Default: 10. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Regions

**Slug:** `VIMEO_LIST_ON_DEMAND_REGIONS`

List countries and regions in the public Vimeo On Demand catalog. Vimeo returns the full catalog on every request; this action trims it client-side and returns a local cursor until every region is reachable. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum regions to return (1-100). Default: 10. |
| `cursor` | string | No | Local continuation cursor returned by this action; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Seasons

**Slug:** `VIMEO_LIST_ON_DEMAND_SEASONS`

List one page of seasons for a public Vimeo On Demand title and return next_cursor. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date" | "manual") | No | Field used to sort seasons. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | string | No | Filter to viewable seasons. |
| `per_page` | integer | No | Maximum seasons to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Season Videos

**Slug:** `VIMEO_LIST_ON_DEMAND_SEASON_VIDEOS`

List one page of On Demand season video metadata and return next_cursor; playback entitlement is not implied. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date" | "default" | "manual" | "name" | "purchase_time" | "release_date") | No | Field used to sort videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | string | No | Filter to viewable videos. |
| `per_page` | integer | No | Maximum videos to return (1-100). Default: 10. |
| `season_id` | integer | Yes | The ID of the season. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Title Genres

**Slug:** `VIMEO_LIST_ON_DEMAND_TITLE_GENRES`

List genres assigned to a public Vimeo On Demand title. Vimeo returns the full relation; limit trims the returned data client-side and does not reduce provider data transfer. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum genres to return (1-100). Default: 10. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Titles By Genre

**Slug:** `VIMEO_LIST_ON_DEMAND_TITLES_BY_GENRE`

List one page of public Vimeo On Demand titles in a genre and return next_cursor. my_region is the only supported region filter; country is unsupported and rejected. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "name" | "publish.time" | "videos") | No | Field used to sort titles. |
| `query` | string | No | Search text used to filter titles. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | string | No | The only supported region filter is my_region, which limits titles to the connected user's region. country is unsupported and rejected. |
| `genre_id` | string | Yes | The ID of the On Demand genre. |
| `per_page` | integer | No | Maximum titles to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Demand Title Videos

**Slug:** `VIMEO_LIST_ON_DEMAND_TITLE_VIDEOS`

List one page of On Demand title video metadata and return next_cursor; playback entitlement is not implied. Vimeo On Demand is being discontinued; these reads are expected to stop after Nov 20, 2026.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date" | "default" | "episode" | "manual" | "name" | "purchase_time" | "release_date") | No | Field used to sort title videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `filter` | string ("all" | "buy" | "expiring_soon" | "extra" | "main" | "main.viewable" | "rent" | "trailer" | "unwatched" | "viewable" | "watched") | No | Attribute used to filter title videos. |
| `per_page` | integer | No | Maximum videos to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `ondemand_id` | integer | Yes | The ID of the On Demand page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Portfolios

**Slug:** `VIMEO_LIST_PORTFOLIOS`

Return one page of portfolios for the connected Vimeo user, or for the Vimeo user selected by optional user_id. Portfolios are available with Standard or Advanced; a Free account may return a successful empty list. Pass next_cursor as cursor to fetch the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Portfolio sort field: alphabetical or date. |
| `query` | string | No | Search query used to filter portfolios. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `user_id` | integer | No | Numeric Vimeo user ID whose portfolios to list; omit for the connected user. |
| `per_page` | integer | No | Number of portfolios to return per page, up to 100. Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction: asc or desc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Showcases

**Slug:** `VIMEO_LIST_SHOWCASES`

Return one searchable, sortable page of Showcases owned by the connected Vimeo user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "duration" | "last_modified" | "videos") | No | Field used to sort Showcases. |
| `query` | string | No | Search text used to filter Showcases. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Maximum Showcases to return in this page (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |
| `filter_privacy` | string | No | Comma-separated Showcase privacies to include. Values: anybody, embed_only, nobody, password, team, unlisted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Feed

**Slug:** `VIMEO_LIST_USER_FEED`

Return one page of Activity records from a Vimeo user's feed. Use GET_CURRENT_USER to obtain the connected user's ID for self workflows. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("appears" | "category_featured" | "channel" | "facebook_feed" | "following" | "group" | "likes" | "ondemand_publish" | "share" | "tagged_with" | "twitter_timeline" | "uploads") | No | Optional activity type used to filter the feed. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `offset` | string | No | Optional Vimeo feed pagination offset. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of activities to return (1-100). Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Folders

**Slug:** `VIMEO_LIST_USER_FOLDERS`

Return one page of folders belonging to a Vimeo user or team owner. Vimeo's legacy API path calls folders projects; pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date" | "default" | "modified_time" | "name" | "pinned_on") | No | Way to sort the folders. |
| `query` | string | No | Search query used to filter folders. |
| `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. |
| `user_id` | integer | Yes | Numeric Vimeo user or team owner ID. |
| `per_page` | integer | No | Number of folders to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Followed Categories

**Slug:** `VIMEO_LIST_USER_FOLLOWED_CATEGORIES`

Return one page of categories followed by a Vimeo user. Use GET_CURRENT_USER to obtain the connected user's ID for self workflows. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "name") | No | Optional field used to sort followed categories. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of categories to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Followed Channels

**Slug:** `VIMEO_LIST_USER_FOLLOWED_CHANNELS`

Return one page of channels followed by a Vimeo user. Use GET_CURRENT_USER to obtain the connected user's ID for self workflows. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "followers" | "videos") | No | Optional field used to sort followed channels. |
| `query` | string | No | Search text used to filter followed channels. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string | No | Set to moderated to return channels the user moderates. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of channels to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Followers

**Slug:** `VIMEO_LIST_USER_FOLLOWERS`

Return one page of followers of a Vimeo user. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Optional field used to sort followers. |
| `query` | string | No | Search text used to filter followers. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of followers to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Following

**Slug:** `VIMEO_LIST_USER_FOLLOWING`

Return one page of users followed by a Vimeo user. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Optional field used to sort followed users. |
| `query` | string | No | Search text used to filter followed users. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string | No | Set to online to return users who are currently online. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of followed users to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Liked Videos

**Slug:** `VIMEO_LIST_USER_LIKED_VIDEOS`

Return one page of videos liked by a Vimeo user. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "comments" | "date" | "duration" | "likes" | "plays") | No | Optional field used to sort liked videos. |
| `query` | string | No | Search text used to filter liked videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string | No | Set to embeddable to filter by embeddability; this must be paired with filter_embeddable. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of videos to return (1-100). Default: 10. |
| `filter_embeddable` | boolean | No | Choose embeddable true or non-embeddable false videos; this must be paired with filter='embeddable'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Pictures

**Slug:** `VIMEO_LIST_USER_PICTURES`

Return one page of profile pictures for a Vimeo user. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of pictures to return (1-100). Default: 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Watch Later

**Slug:** `VIMEO_LIST_USER_WATCH_LATER`

Return one page of videos in a Vimeo user's Watch Later queue. Use GET_CURRENT_USER to obtain the connected user's ID for self workflows. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "comments" | "date" | "duration" | "likes" | "plays") | No | Optional field used to sort Watch Later videos. |
| `query` | string | No | Search text used to filter Watch Later videos. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `filter` | string | No | Set to embeddable to filter by embeddability; this must be paired with filter_embeddable. |
| `user_id` | integer | Yes | Numeric Vimeo user ID. |
| `per_page` | integer | No | Number of videos to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |
| `filter_embeddable` | boolean | No | Choose embeddable true or non-embeddable false videos; this must be paired with filter='embeddable'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Video Categories

**Slug:** `VIMEO_LIST_VIDEO_CATEGORIES`

List categories assigned to a public Vimeo video.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque next_cursor returned by this action; omit for the first page. |
| `per_page` | integer | No | The number of categories to return on this page (1-100). Default: 10. |
| `video_id` | integer | Yes | The ID of the video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Video Likers

**Slug:** `VIMEO_LIST_VIDEO_LIKERS`

Return one page of users who liked a public Vimeo video. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date") | No | Optional field used to sort users who liked the video. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Number of users to return (1-100). Default: 10. |
| `video_id` | integer | Yes | Numeric Vimeo video ID. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Users

**Slug:** `VIMEO_SEARCH_USERS`

Return one page of public Vimeo user profiles matching a search. Use next_cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("alphabetical" | "date" | "followers" | "relevant" | "videos") | No | Optional field used to sort matching users. |
| `query` | string | Yes | Required search text; Vimeo rejects user searches without it. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `per_page` | integer | No | Number of users to return (1-100). Default: 10. |
| `direction` | string ("asc" | "desc") | No | Optional result sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |