Vimeo

This method returns the full OpenAPI specification for the Vimeo API.

This method uses the OAuth protocol to authorize a client. For details on OAuth client authorization, see our [Working with Authentication](/api/authentication) guide or the [OAuth spec](https://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.4).

{
  "content": {
    "application/vnd.vimeo.auth+json": {
      "schema": {
        "$ref": "#/components/schemas/ClientAuthRequest"
      }
    }
  },
  "required": true
}

This method exchanges a legacy Advanced API OAuth 1 token for an API v3 OAuth 2 token.

{
  "content": {
    "application/vnd.vimeo.auth+json": {
      "schema": {
        "$ref": "#/components/schemas/AuthenticationExtrasConvertOAuth1ToOAuth2Request"
      }
    }
  },
  "required": true
}

This method verifies that an OAuth 2 access token exists.

This method revokes the access token that the requesting app is currently using. The token must be of the OAuth 2 type.

This method exchanges an OAuth authorization code for an OAuth access token.

{
  "content": {
    "application/vnd.vimeo.auth+json": {
      "schema": {
        "$ref": "#/components/schemas/AuthenticationExtrasExchangeOAuthCodeExchangeRequest"
      }
    }
  },
  "required": true
}

This method returns every channel that belongs to the specified category.

This method returns every available category.

This method returns the specified category.

This method returns every group that belongs to the specified category.

This method returns every category that the authenticated user follows.

This method causes the authenticated user to stop following the specified category.

This method determines whether the authenticated user follows the specified category.

This method causes the authenticated user to follow the specified category.

This method returns every category that the authenticated user follows.

This method causes the authenticated user to stop following the specified category.

This method determines whether the authenticated user follows the specified category.

This method causes the authenticated user to follow the specified category.

This method returns every video that belongs to the specified category.

This method returns a single video in the specified category. You can use this method to determine whether the video belongs to the category.

This method returns every category that contains the specified video.

This method sets multiple categories and subcategories for the specified video. Include the categories as a JSON block in the body of the request using the **category** field, like this: `[{ "category": "Tech" }, { "category": "Music" }]`. The authenticated user must have edit access to the video. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

{
  "content": {
    "application/vnd.vimeo.category+json": {
      "schema": {
        "$ref": "#/components/schemas/CategoriesVideosSetVideoCategoriesRequest"
      }
    }
  },
  "required": true
}

This method returns every category to which the specified channel belongs.

This method adds the specified channel to multiple categories.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsCategoriesAddChannelToMultipleCategoriesRequest"
      }
    }
  },
  "required": true
}

This method removes a channel from the specified category. The authenticated user must be the owner of the channel.

This method adds the specified channel to a single category. The authenticated user must be the owner of the channel.

This method returns all available channels.

This method creates a new channel.

{
  "content": {
    "application/vnd.vimeo.channel+json": {
      "schema": {
        "$ref": "#/components/schemas/CreateChannelRequest"
      }
    }
  },
  "required": true
}

This method deletes the specified channel.

This method returns a single channel.

This method edits the specified channel.

{
  "content": {
    "application/vnd.vimeo.channel+json": {
      "schema": {
        "$ref": "#/components/schemas/EditChannelRequest"
      }
    }
  },
  "required": false
}

This method returns all the channels to which the specified user subscribes.

This method returns all the channels to which the specified user subscribes.

This method removes multiple moderators from the specified channel. The authenticated user must be the owner of the channel.

{
  "content": {
    "application/vnd.vimeo.user+json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsModeratorsRemoveMultipleFromChannelRequest"
      }
    }
  },
  "required": true
}

This method returns every moderator of the specified channel.

This method replaces the current list of channel moderators with a new list. The authenticated user must be the owner of the channel and a follower of each requested user to add them as a channel moderator.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsModeratorsReplaceModeratorsRequest"
      }
    }
  },
  "required": true
}

This method adds multiple users as moderators to the specified channel. Include the users by their URI as a JSON array in the body of the request using the **user_uri** field, like this: `[{ "user_uri": "/users/1234" }, { "user_uri": "/users/1235" }]`. The authenticated user must be a follower of a requested user to add this person as a moderator. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

This method removes a single moderator from the specified channel. The authenticated user must be the owner of the channel.

This method returns a single moderator of the specified channel.

This method adds a single user as a moderator to the specified channel. The authenticated user must be a follower of the requested user to add them as a channel moderator.

This method returns all the users who have access to the specified private channel. The authenticated user must be the owner of the channel.

This method gives multiple users access to the specified private channel. The authenticated user must be the owner of the channel.

{
  "content": {
    "application/vnd.vimeo.user+json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsPrivateChannelMembersPermitUserAccessRequest"
      }
    }
  },
  "required": true
}

This method prevents a single user from being able to access the specified private channel. The authenticated user must be the owner of the channel.

This method gives a single user access to the specified private channel. The authenticated user must be the owner of the channel.

This method returns every follower of the specified channel.

This method unsubscribes the authenticated user from the specified channel.

This method determines whether the specified user is a follower of a particular channel.

This method subscribes the authenticated user to the specified channel.

This method unsubscribes the authenticated user from the specified channel.

This method determines whether the specified user is a follower of a particular channel.

This method subscribes the authenticated user to the specified channel.

This method returns every tag that has been added to the specified channel.

This method adds multiple tags to the specified channel. Include the tags as a JSON array in the body of the request using the **tag** field, like this: `[{ "tag": "funny" }, { "tag": "concert" }]`. The authenticated user must be the owner of the channel. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

{
  "content": {
    "application/vnd.vimeo.tag+json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsTagsAddMultipleTagsToChannelRequest"
      }
    }
  },
  "required": true
}

This method removes a single tag from the specified channel. The authenticated user must be the owner of the channel.

This method determines whether a tag has been added to the specified channel.

This method adds a single tag to the specified channel. The authenticated user must be the owner of the channel.

This method removes multiple videos from the specified channel. Include the videos by their URI as a JSON block in the body of the request using the **video_uri** field, like this: `[{ "video_uri": "/videos/1234" }, { "video_uri": "/videos/1235" }]`. The authenticated user must be a moderator of the channel. For more information on batch requests like this one, see [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests).

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsVideosRemoveMultipleFromChannelRequest"
      }
    }
  },
  "required": true
}

This method returns every video in the specified channel.

This method adds multiple videos to the specified channel. The authenticated user must be a moderator of the channel.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ChannelsVideosAddMultipleToChannelRequest"
      }
    }
  },
  "required": true
}

This method removes a single video from the specified channel. The authenticated user must be a moderator of the channel.

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

This method adds a single video to the specified channel. The authenticated user must be a moderator of the channel.

This method returns every channel to which the authenticated user can add or remove the specified video. The authenticated user must be a moderator of the channel.

This method returns every custom logo that belongs to the authenticated user or team owner.

This method adds a custom logo representing the authenticated user for display in the embedded player. Be sure to use this method in the context of the multi-step upload procedure described in our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails#uploading-a-thumbnail) guide. This method represents Step 2 of the procedure.

This method deletes the specified custom logo belonging to the authenticated user.

This method returns a single custom logo belonging to the authenticated user.

This method returns every custom logo that belongs to the authenticated user or team owner.

This method adds a custom logo representing the authenticated user for display in the embedded player. Be sure to use this method in the context of the multi-step upload procedure described in our [Working with Thumbnail Uploads](https://developer.vimeo.com/api/upload/thumbnails#uploading-a-thumbnail) guide. This method represents Step 2 of the procedure.

This method deletes the specified custom logo belonging to the authenticated user.

This method returns a single custom logo belonging to the authenticated user.

This method returns every embed preset that belongs to the authenticated user.

This method creates an embed preset.

{
  "content": {
    "application/vnd.vimeo.preset+json": {
      "schema": {
        "$ref": "#/components/schemas/EmbedPresetsEssentialsCreatePresetRequest"
      }
    }
  },
  "required": false
}

This method returns a single embed preset. The authenticated user must be the owner of the preset.

This method edits the specified embed preset. The authenticated user must be the owner of the preset.

{
  "content": {
    "application/vnd.vimeo.preset+json": {
      "schema": {
        "$ref": "#/components/schemas/EmbedPresetsEssentialsEditPresetRequest"
      }
    }
  },
  "required": false
}

This method returns every embed preset that belongs to the authenticated user.

This method creates an embed preset.

{
  "content": {
    "application/vnd.vimeo.preset+json": {
      "schema": {
        "$ref": "#/components/schemas/EmbedPresetsEssentialsCreateEmbedPresetRequest"
      }
    }
  },
  "required": false
}

This method returns a single embed preset. The authenticated user must be the owner of the preset.

This method edits the specified embed preset. The authenticated user must be the owner of the preset.

{
  "content": {
    "application/vnd.vimeo.preset+json": {
      "schema": {
        "$ref": "#/components/schemas/EmbedPresetsEssentialsEditPresetRequest1"
      }
    }
  },
  "required": false
}

This method adds a timeline event thumbnail to the specified video. The authenticated user must be the owner of the video.

This method returns a single timeline event thumbnail that belongs to the specified video.

This method returns every video to which the specified embed preset has been added. The authenticated user must be the owner of videos.

This method returns every video to which the specified embed preset has been added. The authenticated user must be the owner of videos.

This method removes the specified embed preset from a video. The authenticated user must either be the owner of the video or a team user with the contributor or admin role.

This method determines whether a video has the specified embed preset.

This method adds an embed preset to the specified video. The authenticated user must either be the owner of the video or a team user with the contributor or admin role.

This method returns all the folders belonging to the authenticated user.

This method creates a new folder for the authenticated user. By default, this method creates a top-level folder. To create a subfolder — that is, to place the new folder inside an existing folder — specify the parent folder by URI with the **parent_folder_uri** parameter in the body of the request.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FoldersEssentialsCreateFolderRequest"
      }
    }
  },
  "required": true
}

This method deletes the specified folder and optionally also the videos that it contains. The authenticated user must be the owner of the folder.

This method returns a single folder belonging to the authenticated user.

This method edits the specified folder. The authenticated user must be the owner of the folder.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FoldersEssentialsEditFolderRequest"
      }
    }
  },
  "required": true
}

This method returns the specified private-to-me folder.

This method returns all the folders belonging to the authenticated user.

This method creates a new folder for the authenticated user. By default, this method creates a top-level folder. To create a subfolder — that is, to place the new folder inside an existing folder — specify the parent folder by URI with the **parent_folder_uri** parameter in the body of the request.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CreateProjectRequest"
      }
    }
  },
  "required": true
}

This method deletes the specified folder and optionally also the videos that it contains. The authenticated user must be the owner of the folder.

This method returns a single folder belonging to the authenticated user.

This method edits the specified folder. The authenticated user must be the owner of the folder.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EditProjectRequest"
      }
    }
  },
  "required": true
}

This method removes all items from the specified folder.

This method returns every item that belongs to the specified folder.

This method returns every item that belongs to the specified folder.

This method removes multiple videos from the specified folder. The authenticated user must be the owner of the folder.

This method returns all the videos that belong to the specified folder.

This method adds multiple videos to the specified folder. The authenticated user must be the owner of the folder.

This method removes a single video from the specified folder. Please note that this doesn't delete the video itself.

This method adds a single video to the specified folder. The authenticated user must be the owner of the folder.

This method removes multiple videos from the specified folder. The authenticated user must be the owner of the folder.

This method returns all the videos that belong to the specified folder.

This method adds multiple videos to the specified folder. The authenticated user must be the owner of the folder.

This method removes a single video from the specified folder. Please note that this doesn't delete the video itself.

This method adds a single video to the specified folder. The authenticated user must be the owner of the folder.

This method returns every available group.

This method creates a new group.

{
  "content": {
    "application/vnd.vimeo.group+json": {
      "schema": {
        "$ref": "#/components/schemas/CreateGroupRequest"
      }
    }
  },
  "required": true
}

This method deletes the specified group. The authenticated user must be the owner of the group.

This method returns the specified group.

This method removes the authenticated user from the specified group. The authenticated user can't be the owner of the group; assign a new owner through a PATCH request first.

This method adds the authenticated user to the specified group.

This method removes the authenticated user from the specified group. The authenticated user can't be the owner of the group; assign a new owner through a PATCH request first.

This method adds the authenticated user to the specified group.

This method returns every user who belongs to the specified group.

This method returns every group to which the authenticated user belongs.

This method determines whether the authenticated user belongs to the specified group.

This method returns every group to which the authenticated user belongs.

This method determines whether the authenticated user belongs to the specified group.

This method returns every video from the specified group.

This method removes a video from the specified group. The authenticated user must be the owner of the group.

This method returns a single video from the specified group. You can use this method to determine whether the video belongs to the group.

This method adds a video to the specified group. The authenticated user must be the owner of the group.

This method returns every user who has liked the specified video.

This method returns every video that the authenticated user has liked.

This method causes the authenticated user to unlike the specified video.

This method checks if the authenticated user has liked the specified video.

This method causes the authenticated user to like the specified video. The user can't like their own video.

This method returns every user who has liked the specified video on an On Demand page.

This method returns every video that the authenticated user has liked.

This method causes the authenticated user to unlike the specified video.

This method checks if the authenticated user has liked the specified video.

This method causes the authenticated user to like the specified video. The user can't like their own video.

This method returns every user who has liked the specified video.

This method returns every whitelisted domain for an event. The embed privacy setting must be `whitelist`.

This method embeds an event on the specified domains. The embed privacy setting must be `whitelist`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LiveEmbedPrivacyEmbedEventOnDomainsRequest"
      }
    }
  },
  "required": false
}

This method returns every whitelisted domain for an event. The embed privacy setting must be `whitelist`.

This method embeds an event on the specified domains. The embed privacy setting must be `whitelist`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LiveEmbedPrivacyEmbedEventOnDomainsRequest1"
      }
    }
  },
  "required": false
}

This method returns every whitelisted domain for an event. The embed privacy setting must be `whitelist`.

This method embeds an event on the specified domains. The embed privacy setting must be `whitelist`.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LiveEmbedPrivacyEmbedEventOnDomainsRequest2"
      }
    }
  },
  "required": false
}

This method deletes multiple events belonging to the authenticated user.

{
  "content": {
    "application/vnd.vimeo.live.event.recurring+json": {
      "schema": {
        "$ref": "#/components/schemas/LiveEssentialsDeleteMultipleEventsRequest"
      }
    }
  },
  "required": true
}

The method returns every event belonging to the authenticated user.

This method creates a new event for the authenticated user.

{
  "content": {
    "application/vnd.vimeo.live.event.recurring+json": {
      "schema": {
        "$ref": "#/components/schemas/LiveEssentialsCreateEventRequest"
      }
    }
  },
  "required": true
}

This method deletes a single event belonging to the authenticated user.