@datafire/vimeo NPM

@datafire/vimeo

Client library for Vimeo

Installation and Usage

npm install --save @datafire/vimeo

let vimeo = require('@datafire/vimeo').create({
  bearer: "",
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

vimeo.oauthCallback({
  "code": ""
}, context)

Input

input object
- code required string

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

oauthRefresh

Exchange a refresh_token for an access_token

vimeo.oauthRefresh(null, context)

Input

This action has no parameters

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

get_endpoints

Get an API specification

vimeo.get_endpoints({}, context)

Input

input object
- openapi boolean: Return an OpenAPI specification.

Output

output endpoint

get_categories

This method gets all existing categories.

vimeo.get_categories({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: last_video_featured_time, name): The way to sort the results.

Output

output array
- items category

get_category

Get a specific category

vimeo.get_category({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.

Output

output category

get_category_channels

Get all the channels in a category

vimeo.get_category_channels({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, followers, videos): The way to sort the results.

Output

output array
- items channel

get_category_groups

Get all the groups in a category

vimeo.get_category_groups({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, members, videos): The way to sort the results.

Output

output array
- items group

get_category_videos

Get all the videos in a category

vimeo.get_category_videos({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: conditional_featured, embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, comments, date, duration, featured, likes, plays, relevant): The way to sort the results.

Output

output array
- items video

check_category_for_video

Check for a video in a category

vimeo.check_category_for_video({
  "category": "",
  "video_id": 0
}, context)

Input

input object
- category required string: The name of the category.
- video_id required number: The ID of the video.

Output

output video

get_channels

Get all channels

vimeo.get_channels({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: featured): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, followers, relevant, videos): The way to sort the results.

Output

output array
- items channel

create_channel

This method creates a new channel.

vimeo.create_channel({
  "body": {
    "name": "",
    "privacy": ""
  }
}, context)

Input

input object
- body required object
  - description string: The description of the channel.
  - link string: The link to access the channel. You can use a custom name in the URL in place of a numeric channel ID, as in /channels/{url_custom}.
  - name required string: The name of the channel.
  - privacy required string (values: anybody, moderators, user): The privacy level of the channel.

Output

output channel

delete_channel

Delete a channel

vimeo.delete_channel({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

Output schema unknown

get_channel

Get a specific channel

vimeo.get_channel({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

output channel

edit_channel

This method edits the specified channel.

vimeo.edit_channel({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body object
  - description string: The description of the channel.
  - link string: The link to access the channel. You can use a custom name in the URL in place of a numeric channel ID, as in /channels/{url_custom}. Submitting "" for this field removes the link alias.
  - name string: The name of the channel.
  - privacy string (values: anybody, moderators, users): The privacy level of the channel.

Output

output channel

get_channel_categories

This method gets all the categories in the specified channel.

vimeo.get_channel_categories({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

output array
- items category

add_channel_categories

This method adds multiple categories to the specified channel.

vimeo.add_channel_categories({
  "channel_id": 0,
  "body": {
    "channels": []
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - channels required array: The array of category URIs to add.
    - items string

Output

Output schema unknown

delete_channel_category

This method removes a single category from the specified channel.

vimeo.delete_channel_category({
  "category": "",
  "channel_id": 0
}, context)

Input

input object
- category required string: The name of the category.
- channel_id required number: The ID of the channel.

Output

Output schema unknown

categorize_channel

This method adds a channel to a category.

vimeo.categorize_channel({
  "category": "",
  "channel_id": 0
}, context)

Input

input object
- category required string: The name of the category.
- channel_id required number: The ID of the channel.

Output

Output schema unknown

remove_channel_moderators

Remove a list of channel moderators

vimeo.remove_channel_moderators({
  "channel_id": 0,
  "body": {
    "user_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - user_uri required string: The URI of a user to remove as a moderator.

Output

output user

get_channel_moderators

Get all the moderators in a channel

vimeo.get_channel_moderators({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

replace_channel_moderators

Replace the moderators of a channel

vimeo.replace_channel_moderators({
  "channel_id": 0,
  "body": {
    "user_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - user_uri required string: The URI of the user to add as a moderator.

Output

output array
- items user

add_channel_moderators

Add a list of channel moderators

vimeo.add_channel_moderators({
  "channel_id": 0,
  "body": {
    "user_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - user_uri required string: The URI of a user to add as a moderator.

Output

Output schema unknown

remove_channel_moderator

Remove a specific channel moderator

vimeo.remove_channel_moderator({
  "channel_id": 0,
  "user_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- user_id required number: The ID of the user.

Output

Output schema unknown

get_channel_moderator

Get a specific channel moderator

vimeo.get_channel_moderator({
  "channel_id": 0,
  "user_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- user_id required number: The ID of the user.

Output

output user

add_channel_moderator

Add a specific channel moderator

vimeo.add_channel_moderator({
  "channel_id": 0,
  "user_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- user_id required number: The ID of the user.

Output

output legacy-error

get_channel_privacy_users

This method gets all the users who have access to the specified private channel.

vimeo.get_channel_privacy_users({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items user

set_channel_privacy_users

This method gives multiple users access to the specified private channel.

vimeo.set_channel_privacy_users({
  "channel_id": 0,
  "body": {
    "users": []
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - users required array: The array of either the user URIs or the user IDs to permit to view the private channel.
    - items string

Output

output array
- items user

delete_channel_privacy_user

This method prevents a single user from being able to access the specified private channel.

vimeo.delete_channel_privacy_user({
  "channel_id": 0,
  "user_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- user_id required number: The ID of the user.

Output

Output schema unknown

set_channel_privacy_user

This method gives a single user access to the specified private channel.

vimeo.set_channel_privacy_user({
  "channel_id": 0,
  "user_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- user_id required number: The ID of the user.

Output

Output schema unknown

get_channel_tags

This method gets all the tags that have been added to the specified channel.

vimeo.get_channel_tags({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

output array
- items tag

add_tags_to_channel

This method adds multiple tags to the specified channel.

vimeo.add_tags_to_channel({
  "channel_id": 0,
  "body": {
    "tag": []
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - tag required array: An array of tags to assign.
    - items string

Output

output array
- items tag

delete_tag_from_channel

This method removes a single tag from the specified channel.

vimeo.delete_tag_from_channel({
  "channel_id": 0,
  "word": ""
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- word required string: The word to use as the tag.

Output

Output schema unknown

check_if_channel_has_tag

This method determines whether a specific tag has been added to the channel in question.

vimeo.check_if_channel_has_tag({
  "channel_id": 0,
  "word": ""
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- word required string: The word to use as the tag.

Output

Output schema unknown

add_channel_tag

This method adds a single tag to the specified channel.

vimeo.add_channel_tag({
  "channel_id": 0,
  "word": ""
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- word required string: The word to use as the tag.

Output

Output schema unknown

get_channel_subscribers

Get all the followers of a channel

vimeo.get_channel_subscribers({
  "channel_id": 0,
  "filter": ""
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- direction string (values: asc, desc): The sort direction of the results.
- filter required string (values: moderators): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

remove_videos_from_channel

Remove a list of videos from a channel

vimeo.remove_videos_from_channel({
  "channel_id": 0,
  "body": {
    "video_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - video_uri required string: The URI of a video to remove.

Output

output video

get_channel_videos

Get all the videos in a channel

vimeo.get_channel_videos({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- containing_uri string: The page that contains the video URI.
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: added, alphabetical, comments, date, default, duration, likes, manual, modified_time, plays): The way to sort the results.

Output

output array
- items video

add_videos_to_channel

Add a list of videos to a channel

vimeo.add_videos_to_channel({
  "channel_id": 0,
  "body": {
    "video_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- body required object
  - video_uri required string: The URI of a video to add.

Output

Output schema unknown

delete_video_from_channel

Remove a specific video from a channel

vimeo.delete_video_from_channel({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_channel_video

This method returns a specific video in a channel. You can use it to determine whether the video is in the channel.

vimeo.get_channel_video({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.

Output

output video

add_video_to_channel

Add a specific video to a channel

vimeo.add_video_to_channel({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_comments_alt1

Get all the comments on a video

vimeo.get_comments_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items comment

create_comment_alt1

Add a comment to a video

vimeo.create_comment_alt1({
  "channel_id": 0,
  "video_id": 0,
  "body": {
    "text": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- body required object
  - text required string: The text of the comment.

Output

output comment

get_video_credits_alt1

Get all the credited users in a video

vimeo.get_video_credits_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items credit

add_video_credit_alt1

Credit a user in a video

vimeo.add_video_credit_alt1({
  "channel_id": 0,
  "video_id": 0,
  "body": {
    "email": "",
    "name": "",
    "role": "",
    "user_uri": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- body required object
  - email required string: The email address of the credited person.
  - name required string: The name of the credited person.
  - role required string: The role of the credited person.
  - user_uri required string: The URI of the Vimeo user who should be given credit in this video.

Output

output credit

get_video_likes_alt1

Get all the users who have liked a video

vimeo.get_video_likes_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

get_video_thumbnails_alt1

Get all the thumbnails of a video

vimeo.get_video_thumbnails_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items picture

create_video_thumbnail_alt1

Add a video thumbnail

vimeo.create_video_thumbnail_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- body object
  - active boolean: Whether the image created by the time field should be the default thumbnail for the video.
  - time number: Creates an image of the video from the given time offset.

Output

output picture

get_video_privacy_users_alt1

Get all the users who can view a user's private videos by default

vimeo.get_video_privacy_users_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items user

add_video_privacy_users_alt1

The body of this request should follow our batch request format. Each object must contain a single URI field, and the value of this field must be the URI of the user who can view this video.

vimeo.add_video_privacy_users_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.

Output

output array
- items user

get_text_tracks_alt1

Get all the text tracks of a video

vimeo.get_text_tracks_alt1({
  "channel_id": 0,
  "video_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.

Output

output array
- items text-track

create_text_track_alt1

For additional information, see our text track upload guide.

vimeo.create_text_track_alt1({
  "channel_id": 0,
  "video_id": 0,
  "body": {
    "language": "",
    "name": "",
    "type": ""
  }
}, context)

Input

input object
- channel_id required number: The ID of the channel.
- video_id required number: The ID of the video.
- body required object
  - active boolean: Active text tracks appear in the player and are visible to other users. Only one text track per language can be active.
  - language required string: The language of the text track. For a complete list of valid languages, use the /languages?filter=texttracks endpoint.
  - name required string: The name of the text track.
  - type required string (values: captions, chapters, descriptions, metadata, subtitles): The type of the text track.

Output

output text-track

get_content_ratings

Get all content ratings

vimeo.get_content_ratings(null, context)

Input

This action has no parameters

Output

output array
- items content-rating

get_cc_licenses

Get all Creative Commons licenses

vimeo.get_cc_licenses(null, context)

Input

This action has no parameters

Output

output array
- items creative-commons

get_groups

Get all groups

vimeo.get_groups({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: featured): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, followers, relevant, videos): The way to sort the results.

Output

output array
- items group

create_group

Create a group

vimeo.create_group({
  "body": {
    "name": ""
  }
}, context)

Input

input object
- body required object
  - description string: The description of the new group.
  - name required string: The name of the new group.

Output

output group

delete_group

Delete a group

vimeo.delete_group({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.

Output

Output schema unknown

get_group

Get a specific group

vimeo.get_group({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.

Output

output group

get_group_members

Get all the members of a group

vimeo.get_group_members({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: moderators): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

get_group_videos

Get all the videos in a group

vimeo.get_group_videos({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, comments, date, duration, likes, plays): The way to sort the results.

Output

output array
- items video

delete_video_from_group

Remove a video from a group

vimeo.delete_video_from_group({
  "group_id": 0,
  "video_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_group_video

Check if a group has a video.

vimeo.get_group_video({
  "group_id": 0,
  "video_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.
- video_id required number: The ID of the video.

Output

output video

add_video_to_group

Add a video to a group

vimeo.add_video_to_group({
  "group_id": 0,
  "video_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.
- video_id required number: The ID of the video.

Output

output video

get_languages

Get all languages

vimeo.get_languages({}, context)

Input

input object
- filter string (values: texttracks): The attribute by which to filter the results.

Output

output array
- items language

get_user_alt1

Get a user

vimeo.get_user_alt1(null, context)

Input

This action has no parameters

Output

output user

edit_user_alt1

Edit a user

vimeo.edit_user_alt1({}, context)

Input

input object
- body object
  - bio string: The user's bio.
  - content_filter array: A list of values describing the content in this video. Find the full list in the /contentratings endpoint. You must provide a comma-separated list if you are using a query string or an array if you are using JSON.
    - items string
  - link string: The user's custom Vimeo URL slug.
  - location string: The user's location.
  - name string: The user's display name.
  - password string: The default password for all future videos that this user uploads. To use this field, the videos.privacy.view field must be password.
  - videos object
    - privacy object
      - add boolean: Whether a user can add the video to an album, channel, or group. This value becomes the default add setting for all future videos uploaded by the user.
      - comments string (values: anybody, contacts, nobody): Who can comment on the video. This value becomes the default comment setting for all future videos that this user uploads.
      - download boolean: Whether a user can download the video. This value becomes the default download setting for all future videos that this user uploads.
      - embed string (values: private, public, whitelist): The privacy for embed videos. The whitelist value enables you to define all valid embed domains. See our documentation for adding and removing domains.
      - view string (values: anybody, contacts, disable, nobody, password, unlisted, users): Who can view the video. This value becomes the default view setting for all future videos that this user uploads.

Output

output user

get_albums_alt1

Get all the albums that belong to a user

vimeo.get_albums_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, duration, videos): The way to sort the results.

Output

output array
- items album

create_album_alt1

Create an album

vimeo.create_album_alt1({
  "body": {
    "name": ""
  }
}, context)

Input

input object
- body required object
  - brand_color string: The hexadecimal code for the color of the player buttons.
  - description string: The description of the album.
  - hide_nav boolean: Whether to hide Vimeo navigation when displaying the album.
  - layout string (values: grid, player): The type of layout for presenting the album.
  - name required string: The name of the album.
  - password string: The album's password. Required only if privacy is password.
  - privacy string (values: anybody, embed_only, password): The privacy level of the album.
  - review_mode boolean: Whether album videos should use the review mode URL.
  - sort string (values: added_first, added_last, alphabetical, arranged, comments, likes, newest, oldest, plays): The default sort order of the album's videos.
  - theme string (values: dark, standard): The color theme of the album.

Output

output album

delete_album_alt1

Delete an album

vimeo.delete_album_alt1({
  "album_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.

Output

Output schema unknown

get_album_alt1

Get a specific album

vimeo.get_album_alt1({
  "album_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.

Output

output album

edit_album_alt1

Edit an album

vimeo.edit_album_alt1({
  "album_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- body object
  - brand_color string: The hexadecimal code for the color of the player buttons.
  - description string: The description of the album.
  - domain string: The custom domain a user has selected for their album.
  - hide_nav boolean: Whether to hide Vimeo navigation when displaying the album.
  - layout string (values: grid, player): The type of layout for presenting the album.
  - name string: The name of the album.
  - password string: The album's password. Required only if privacy is password.
  - privacy string (values: anybody, embed_only, password): The privacy level of the album.
  - review_mode boolean: Whether album videos should use the review mode URL.
  - sort string (values: added_first, added_last, alphabetical, arranged, comments, likes, newest, oldest, plays): The default sort order of the album's videos.
  - theme string (values: dark, standard): The color theme of the album.
  - url string: The custom Vimeo URL a user has selected for their album.
  - use_custom_domain boolean: Whether the user has opted in to use a custom domain for their album.

Output

output album

get_album_videos_alt1

Get all the videos in an album

vimeo.get_album_videos_alt1({
  "album_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- containing_uri string: The page containing the video URI.
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- password string: The password of the album.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, comments, date, default, duration, likes, manual, modified_time, plays): The way to sort the results.
- weak_search boolean: Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service performs a partial text search on the video's name.

Output

output array
- items video

replace_videos_in_album_alt1

This method replaces all the existing videos in an album with one or more videos.

vimeo.replace_videos_in_album_alt1({
  "album_id": 0,
  "body": {
    "videos": ""
  }
}, context)

Input

input object
- album_id required number: The ID of the album.
- body required object
  - videos required string: A comma-separated list of video URIs.

Output

Output schema unknown

remove_video_from_album_alt1

Remove a video from an album

vimeo.remove_video_from_album_alt1({
  "album_id": 0,
  "video_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_album_video_alt1

This method gets a single video from an album. You can use this method to determine whether the album contains the specified video.

vimeo.get_album_video_alt1({
  "album_id": 0,
  "video_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- video_id required number: The ID of the video.
- password string: The password of the album.

Output

output video

add_video_to_album_alt1

Add a specific video to an album

vimeo.add_video_to_album_alt1({
  "album_id": 0,
  "video_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- video_id required number: The ID of the video.

Output

Output schema unknown

set_video_as_album_thumbnail_alt1

Set a video as the album thumbnail

vimeo.set_video_as_album_thumbnail_alt1({
  "album_id": 0,
  "video_id": 0
}, context)

Input

input object
- album_id required number: The ID of the album.
- video_id required number: The ID of the video.
- body object
  - time_code number: The video frame time in seconds to use as the album thumbnail.

Output

output album

get_appearances_alt1

Get all the videos in which a user appears

vimeo.get_appearances_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, comments, date, duration, likes, plays): The way to sort the results.

Output

output array
- items video

get_category_subscriptions_alt1

Get all the categories that a user follows

vimeo.get_category_subscriptions_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: alphabetical, date, name): The way to sort the results.

Output

output array
- items category

unsubscribe_from_category_alt1

Unsubscribe a user from a category

vimeo.unsubscribe_from_category_alt1({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.

Output

Output schema unknown

check_if_user_subscribed_to_category_alt1

Check if a user follows a category

vimeo.check_if_user_subscribed_to_category_alt1({
  "category": ""
}, context)

Input

input object
- category required string: The name of the category.

Output

Output schema unknown

subscribe_to_category_alt1

Subscribe a user to a single category

vimeo.subscribe_to_category_alt1({
  "category": 0
}, context)

Input

input object
- category required number: The name of the category.

Output

Output schema unknown

get_channel_subscriptions_alt1

Get all the channels to which a user subscribes

vimeo.get_channel_subscriptions_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: moderated): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, followers, videos): The way to sort the results.

Output

output array
- items channel

unsubscribe_from_channel_alt1

Unsubscribe a user from a specific channel

vimeo.unsubscribe_from_channel_alt1({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

Output schema unknown

check_if_user_subscribed_to_channel_alt1

Check if a user follows a channel

vimeo.check_if_user_subscribed_to_channel_alt1({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

Output schema unknown

subscribe_to_channel_alt1

Subscribe a user to a specific channel

vimeo.subscribe_to_channel_alt1({
  "channel_id": 0
}, context)

Input

input object
- channel_id required number: The ID of the channel.

Output

Output schema unknown

get_custom_logos_alt1

Get all the custom logos that belong to a user

vimeo.get_custom_logos_alt1(null, context)

Input

This action has no parameters

Output

output array
- items picture

create_custom_logo_alt1

Add a custom logo

vimeo.create_custom_logo_alt1(null, context)

Input

This action has no parameters

Output

output picture

get_custom_logo_alt1

Get a specific custom logo

vimeo.get_custom_logo_alt1({
  "logo_id": 0
}, context)

Input

input object
- logo_id required number: The ID of the custom logo.

Output

output picture

get_feed_alt1

Get all videos in a user's feed

vimeo.get_feed_alt1({}, context)

Input

input object
- offset string: Necessary for proper pagination. You shouldn't provide this value yourself, and instead use the pagination links in the feed response. Please see our pagination documentation for more information.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- type string (values: appears, category_featured, channel, facebook_feed, following, group, likes, ondemand_publish, share, tagged_with, twitter_timeline, uploads): The feed type.

Output

output array
- items activity-3-1

get_followers_alt1

Get all the followers of a user

vimeo.get_followers_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

get_user_following_alt1

Get all the users that a user is following

vimeo.get_user_following_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: online): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items user

follow_users_alt1

Follow a list of users

vimeo.follow_users_alt1({
  "body": {
    "users": []
  }
}, context)

Input

input object
- body required object
  - users required array: An array of user URIs for the list of users to follow.
    - items string

Output

Output schema unknown

unfollow_user_alt1

Unfollow a user

vimeo.unfollow_user_alt1({
  "follow_user_id": 0
}, context)

Input

input object
- follow_user_id required number: The ID of the following user.

Output

Output schema unknown

check_if_user_is_following_alt1

Check if a user is following another user

vimeo.check_if_user_is_following_alt1({
  "follow_user_id": 0
}, context)

Input

input object
- follow_user_id required number: The ID of the following user.

Output

Output schema unknown

follow_user_alt1

Follow a specific user

vimeo.follow_user_alt1({
  "follow_user_id": 0
}, context)

Input

input object
- follow_user_id required number: The ID of the following user.

Output

Output schema unknown

get_user_groups_alt1

Get all the groups that a user has joined

vimeo.get_user_groups_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: moderated): The attribute by which to filter the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date, members, videos): The way to sort the results.

Output

output array
- items group

leave_group_alt1

Remove a user from a group

vimeo.leave_group_alt1({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.

Output

Output schema unknown

check_if_user_joined_group_alt1

Check if a user has joined a group

vimeo.check_if_user_joined_group_alt1({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.

Output

Output schema unknown

join_group_alt1

Add a user to a group

vimeo.join_group_alt1({
  "group_id": 0
}, context)

Input

input object
- group_id required number: The ID of the group.

Output

Output schema unknown

get_likes_alt1

Get all the videos that a user has liked

vimeo.get_likes_alt1({}, context)

Input

input object
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, comments, date, duration, likes, plays): The way to sort the results.

Output

output array
- items video

unlike_video_alt1

Cause a user to unlike a video

vimeo.unlike_video_alt1({
  "video_id": 0
}, context)

Input

input object
- video_id required number: The ID of the video.

Output

Output schema unknown

check_if_user_liked_video_alt1

Check if a user has liked a video

vimeo.check_if_user_liked_video_alt1({
  "video_id": 0
}, context)

Input

input object
- video_id required number: The ID of the video.

Output

Output schema unknown

like_video_alt1

Cause a user to like a video

vimeo.like_video_alt1({
  "video_id": 0
}, context)

Input

input object
- video_id required number: The ID of the video.

Output

Output schema unknown

get_user_vods_alt1

Get all the On Demand pages of a user

vimeo.get_user_vods_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: film, series): The type of On Demand pages to return.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: added, alphabetical, date, modified_time, name, publish.time, rating): The way to sort the results.

Output

output array
- items on-demand-page

create_vod_alt1

Create an On Demand page

vimeo.create_vod_alt1({
  "body": {
    "content_rating": "",
    "description": "",
    "name": "",
    "type": ""
  }
}, context)

Input

input object
- body required object
  - accepted_currencies string (values: AUD, CAD, CHF, DKK, EUR, GBP, JPY, KRW, NOK, PLN, SEK, USD): An array of accepted currencies.
  - buy object
    - active boolean: Whether the Buy action is active. *Required if rent.active is false.
    - download boolean: Whether people who buy the video can download it. To use this field, type must be film.
    - price object
      - AUD number: The purchase price of this video in AUD.
      - CAD number: The purchase price of this video in CAD.
      - CHF number: The purchase price of this video in CHF.
      - DKK number: The purchase price of this video in DKK.
      - EUR number: The purchase price of this video in EUR.
      - GBP number: The purchase price of this video in GBP.
      - JPY number: The purchase price of this video in JPY.
      - KRW number: The purchase price of this video in KRW.
      - NOK number: The purchase price of this video in NOK.
      - PLN number: The purchase price of this video in PLN.
      - SEK number: The purchase price of this video in SEK.
      - USD number: The purchase price of this video in USD when type is film, or the purchase price of the entire collection in USD when type is series.
  - content_rating required string (values: drugs, language, nudity, safe, unrated, violence): One or more ratings, either as a comma-separated list or as a JSON array depending on the request format.
  - description required string: The description of the On Demand page.
  - domain_link string: The custom domain of the On Demand page.
  - episodes object
    - buy object
      - active boolean: Whether episodes can be bought.
      - download boolean: Whether people who buy the episode can download it. To use this field, type must be series.
      - price object
        USD number: The purchase price per episode. *Required if episodes.buy.active is true.
    - rent object
      - active boolean: Whether episodes can be rented
      - period string (values: 1 week, 1 year, 24 hour, 3 month, 30 day, 48 hour, 6 month, 72 hour): The period in which this episode can be rented for.
      - price object
        USD number: The default price to rent an episode. This field is applicable only when type is series. *Required if episodes.rent.active is true.
  - link string: The custom string to use in this On Demand page's Vimeo URL.
  - name required string: The name of the On Demand page.
  - rent object
    - active boolean: Whether the video can be rented. *Required if buy.active is false.
    - period string (values: 1 week, 1 year, 24 hour, 3 month, 30 day, 48 hour, 6 month, 72 hour): The period in which this can be rented for.
    - price object
      - AUD number: The rental price of this video in AUD.
      - CAD number: The rental price of this video in CAD.
      - CHF number: The rental price of this video in CHF.
      - DKK number: The rental price of this video in DKK.
      - EUR number: The rental price of this video in EUR.
      - GBP number: The rental price of this video in GBP.
      - JPY number: The rental price of this video in JPY.
      - KRW number: The rental price of this video in KRW.
      - NOK number: The rental price of this video in NOK.
      - PLN number: The rental price of this video in PLN.
      - SEK number: The rental price of this video in SEK.
      - USD number: The rental price of this video in USD when type is film, or the rental price of the entire collection in USD when type is series.
  - subscription object
    - monthly object
      - active boolean: Whether monthly subscription is active. *Required if rent.active and buy.active are false.
      - price object
        USD number: The monthly subscription price in USD. *Required if subscription.active is true.
  - type required string (values: film, series): The type of On Demand page.

Output

output on-demand-page

get_vod_purchases

Get all the On Demand purchases and rentals that a user has made

vimeo.get_vod_purchases({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- filter string (values: all, expiring_soon, film, important, purchased, rented, series, subscription, unwatched, watched): The type of On Demand videos to show.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: added, alphabetical, date, name, purchase_time, rating, release_date): The way to sort the results.

Output

output array
- items on-demand-page

check_if_vod_was_purchased_alt1

Check if a user has made a purchase or rental from an On Demand page

vimeo.check_if_vod_was_purchased_alt1({
  "ondemand_id": 0
}, context)

Input

input object
- ondemand_id required number: The ID of the On Demand.

Output

output on-demand-page

get_pictures_alt1

Get all the pictures that belong to a user

vimeo.get_pictures_alt1({}, context)

Input

input object
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items picture

create_picture_alt1

Add a user picture

vimeo.create_picture_alt1(null, context)

Input

This action has no parameters

Output

output picture

delete_picture_alt1

Delete a user picture

vimeo.delete_picture_alt1({
  "portraitset_id": 0
}, context)

Input

input object
- portraitset_id required number: The ID of the picture.

Output

Output schema unknown

get_picture_alt1

Get a specific user picture

vimeo.get_picture_alt1({
  "portraitset_id": 0
}, context)

Input

input object
- portraitset_id required number: The ID of the picture.

Output

output picture

edit_picture_alt1

Edit a user picture

vimeo.edit_picture_alt1({
  "portraitset_id": 0
}, context)

Input

input object
- portraitset_id required number: The ID of the picture.
- body object
  - active boolean: Whether the picture is the user's active portrait.

Output

output picture

get_portfolios_alt1

Get all the portfolios that belong to a user

vimeo.get_portfolios_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- query string: The search query to use to filter the results.
- sort string (values: alphabetical, date): The way to sort the results.

Output

output array
- items portfolio

get_portfolio_alt1

Get a specific portfolio

vimeo.get_portfolio_alt1({
  "portfolio_id": 0
}, context)

Input

input object
- portfolio_id required number: The ID of the portfolio.

Output

output portfolio

get_portfolio_videos_alt1

Get all the videos in a portfolio

vimeo.get_portfolio_videos_alt1({
  "portfolio_id": 0
}, context)

Input

input object
- portfolio_id required number: The ID of the portfolio.
- containing_uri string: The page that contains the video URI.
- filter string (values: embeddable): The attribute by which to filter the results.
- filter_embeddable boolean: Whether to filter the results by embeddable videos (true) or non-embeddable videos (false). Required only if filter is embeddable.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: alphabetical, comments, date, default, likes, manual, plays): The way to sort the results.

Output

output array
- items video

delete_video_from_portfolio_alt1

Remove a video from a portfolio

vimeo.delete_video_from_portfolio_alt1({
  "portfolio_id": 0,
  "video_id": 0
}, context)

Input

input object
- portfolio_id required number: The ID of the portfolio.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_portfolio_video_alt1

Get a specific video in a portfolio

vimeo.get_portfolio_video_alt1({
  "portfolio_id": 0,
  "video_id": 0
}, context)

Input

input object
- portfolio_id required number: The ID of the portfolio.
- video_id required number: The ID of the video.

Output

output video

add_video_to_portfolio_alt1

Add a video to a portfolio

vimeo.add_video_to_portfolio_alt1({
  "portfolio_id": 0,
  "video_id": 0
}, context)

Input

input object
- portfolio_id required number: The ID of the portfolio.
- video_id required number: The ID of the video.

Output

Output schema unknown

get_embed_presets_alt1

Get all the embed presets that a user has created

vimeo.get_embed_presets_alt1({}, context)

Input

input object
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items presets

get_embed_preset_alt1

Get a specific embed preset

vimeo.get_embed_preset_alt1({
  "preset_id": 0
}, context)

Input

input object
- preset_id required number: The ID of the preset.

Output

output presets

edit_embed_preset_alt1

Edit an embed preset

vimeo.edit_embed_preset_alt1({
  "preset_id": 0
}, context)

Input

input object
- preset_id required number: The ID of the preset.
- body object
  - outro string (values: nothing): Disable the outro.

Output

output presets

get_embed_preset_videos_alt1

Get all the videos that have been added to an embed preset

vimeo.get_embed_preset_videos_alt1({
  "preset_id": 0
}, context)

Input

input object
- preset_id required number: The ID of the preset.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.

Output

output array
- items video

get_projects_alt1

This method gets all the projects that belong to the specified user.

vimeo.get_projects_alt1({}, context)

Input

input object
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: date, default, modified_time, name): The way to sort the results.

Output

output array
- items project

create_project_alt1

This method creates a new project for the specified user.

vimeo.create_project_alt1({
  "body": {
    "name": ""
  }
}, context)

Input

input object
- body required object
  - name required string: The name of the project.

Output

output project

delete_project_alt1

This method deletes a project and optionally also the videos that it contains.

vimeo.delete_project_alt1({
  "project_id": 0
}, context)

Input

input object
- project_id required number: The ID of the project.
- should_delete_clips boolean: Whether to delete all the videos in the project along with the project itself.

Output

Output schema unknown

get_project_alt1

This method gets a single project that belongs to the specified user.

vimeo.get_project_alt1({
  "project_id": 0
}, context)

Input

input object
- project_id required number: The ID of the project.

Output

output project

edit_project_alt1

This method edits an existing project.

vimeo.edit_project_alt1({
  "project_id": 0,
  "body": {
    "name": ""
  }
}, context)

Input

input object
- project_id required number: The ID of the project.
- body required object
  - name required string: The name of the project.

Output

output project

remove_videos_from_project_alt1

This method removed multiple videos from the specified project.

vimeo.remove_videos_from_project_alt1({
  "project_id": 0,
  "uris": ""
}, context)

Input

input object
- project_id required number: The ID of the project.
- should_delete_clips boolean: Whether to delete the videos when removing them from the project.
- uris required string: A comma-separated list of the video URIs to remove.

Output

Output schema unknown

get_project_videos_alt1

This method gets all the videos that belong to the specified project.

vimeo.get_project_videos_alt1({
  "project_id": 0
}, context)

Input

input object
- project_id required number: The ID of the project.
- direction string (values: asc, desc): The sort direction of the results.
- page number: The page number of the results to show.
- per_page number: The number of items to show on each page of results, up to a maximum of 100.
- sort string (values: alphabetical, date, default, duration, last_user_action_event_date): The way to sort the results.

Output

output array
- items video

add_videos_to_project_alt1

This method adds multiple videos to the specified project.

vimeo.add_videos_to_project_alt1({
  "project_id":

datafire

@infinitebrahmanuniverse/nolb-_datafire_v @everything-registry/sub-chunk-222 @zalastax/nolb-_datafire_v

3.0.0

5 years ago