Name | Data Type | Description |
---|---|---|
openapi
|
boolean |
Return an OpenAPI specification. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
endpoint | |||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method gets a single video from an album. You can use this method to determine whether the album contains the specified video.
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
password
|
string |
The password of the album. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
video | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
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. |
sort
|
string Allowed values: - alphabetical - comments - date - default - duration - likes - manual - modified_time - plays |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
password
|
string |
The password of the album. |
page
|
double |
The page number of the results to show. |
filter_embeddable
|
boolean |
Whether to filter the results by embeddable videos ( |
filter
|
string Allowed values: - embeddable |
The attribute by which to filter the results. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
containing_uri
|
string |
The page containing the video URI. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [video] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method replaces all the existing videos in an album with one or more videos.
Name | Data Type | Description |
---|---|---|
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
videos
|
string |
A comma-separated list of video URIs. Examples:/videos/258684937,/videos/273576296 |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method gets a single video from an album. You can use this method to determine whether the album contains the specified video.
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
password
|
string |
The password of the album. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
video | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
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. |
sort
|
string Allowed values: - alphabetical - comments - date - default - duration - likes - manual - modified_time - plays |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
password
|
string |
The password of the album. |
page
|
double |
The page number of the results to show. |
filter_embeddable
|
boolean |
Whether to filter the results by embeddable videos ( |
filter
|
string Allowed values: - embeddable |
The attribute by which to filter the results. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
containing_uri
|
string |
The page containing the video URI. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [video] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method replaces all the existing videos in an album with one or more videos.
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
videos
|
string |
A comma-separated list of video URIs. Examples:/videos/258684937,/videos/273576296 |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method removes a custom logo from the specified album.
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
logo_id
|
double |
The ID of the custom logo. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
logo_id
|
double |
The ID of the custom logo. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
logo_id
|
double |
The ID of the custom logo. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
active
|
boolean |
Whether to make this the active album logo. Examples:true |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [picture] | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method removes a custom uploaded thumbnail from the specified album.
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
thumbnail_id
|
double |
The ID of the custom thumbnail. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
thumbnail_id
|
double |
The ID of the custom thumbnail. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
thumbnail_id
|
double |
The ID of the custom thumbnail. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
active
|
boolean |
Whether to make this the active album thumbnail. Examples:true |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [picture] | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
picture | |||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
use_custom_domain
|
boolean |
Whether the user has opted in to use a custom domain for their album. Examples:true |
url
|
string |
The custom Vimeo URL a user has selected for their album. Examples:my-custom-url |
theme
|
string Allowed values: - dark - standard |
The color theme of the album. |
sort
|
string Allowed values: - added_first - added_last - alphabetical - arranged - comments - likes - newest - oldest - plays |
The default sort order of the album's videos. |
review_mode
|
boolean |
Whether album videos should use the review mode URL. Examples:true |
privacy
|
string Allowed values: - anybody - embed_only - password |
The privacy level of the album. |
password
|
string |
The album's password. Required only if privacy is hunter1 |
name
|
string |
The name of the album. Examples:Vimeo Holiday Videos! |
layout
|
string Allowed values: - grid - player |
The type of layout for presenting the album. |
hide_nav
|
boolean |
Whether to hide Vimeo navigation when displaying the album. Examples:true |
domain
|
string |
The custom domain a user has selected for their album. Examples:mycustomdomain.com |
description
|
string |
The description of the album. Examples:Vimeo holiday videos! |
brand_color
|
string |
The hexadecimal code for the color of the player buttons. Examples:ff66ee |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - duration - videos |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [album] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
theme
|
string Allowed values: - dark - standard |
The color theme of the album. |
sort
|
string Allowed values: - added_first - added_last - alphabetical - arranged - comments - likes - newest - oldest - plays |
The default sort order of the album's videos. |
review_mode
|
boolean |
Whether album videos should use the review mode URL. Examples:true |
privacy
|
string Allowed values: - anybody - embed_only - password |
The privacy level of the album. |
password
|
string |
The album's password. Required only if privacy is hunter1 |
name
|
string |
The name of the album. Examples:Vimeo Holiday Videos! |
layout
|
string Allowed values: - grid - player |
The type of layout for presenting the album. |
hide_nav
|
boolean |
Whether to hide Vimeo navigation when displaying the album. Examples:true |
description
|
string |
The description of the album. Examples:Vimeo holiday videos! |
brand_color
|
string |
The hexadecimal code for the color of the player buttons. Examples:ff66ee |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
album_id
|
double |
The ID of the album. |
Name | Data Type | Description |
---|---|---|
|
object |
use_custom_domain
|
boolean |
Whether the user has opted in to use a custom domain for their album. Examples:true |
url
|
string |
The custom Vimeo URL a user has selected for their album. Examples:my-custom-url |
theme
|
string Allowed values: - dark - standard |
The color theme of the album. |
sort
|
string Allowed values: - added_first - added_last - alphabetical - arranged - comments - likes - newest - oldest - plays |
The default sort order of the album's videos. |
review_mode
|
boolean |
Whether album videos should use the review mode URL. Examples:true |
privacy
|
string Allowed values: - anybody - embed_only - password |
The privacy level of the album. |
password
|
string |
The album's password. Required only if privacy is hunter1 |
name
|
string |
The name of the album. Examples:Vimeo Holiday Videos! |
layout
|
string Allowed values: - grid - player |
The type of layout for presenting the album. |
hide_nav
|
boolean |
Whether to hide Vimeo navigation when displaying the album. Examples:true |
domain
|
string |
The custom domain a user has selected for their album. Examples:mycustomdomain.com |
description
|
string |
The description of the album. Examples:Vimeo holiday videos! |
brand_color
|
string |
The hexadecimal code for the color of the player buttons. Examples:ff66ee |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - duration - videos |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [album] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
Name | Data Type | Description |
---|---|---|
|
object |
theme
|
string Allowed values: - dark - standard |
The color theme of the album. |
sort
|
string Allowed values: - added_first - added_last - alphabetical - arranged - comments - likes - newest - oldest - plays |
The default sort order of the album's videos. |
review_mode
|
boolean |
Whether album videos should use the review mode URL. Examples:true |
privacy
|
string Allowed values: - anybody - embed_only - password |
The privacy level of the album. |
password
|
string |
The album's password. Required only if privacy is hunter1 |
name
|
string |
The name of the album. Examples:Vimeo Holiday Videos! |
layout
|
string Allowed values: - grid - player |
The type of layout for presenting the album. |
hide_nav
|
boolean |
Whether to hide Vimeo navigation when displaying the album. Examples:true |
description
|
string |
The description of the album. Examples:Vimeo holiday videos! |
brand_color
|
string |
The hexadecimal code for the color of the player buttons. Examples:ff66ee |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
album | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
redirect_uri
|
string |
The redirect URI. Must match the URI from https://example.com |
grant_type
|
string Allowed values: - authorization_code |
The grant type. Must be set to |
code
|
string |
The authorization code received from the authorization server. Examples:1234abcd |
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth-error | |||||||||||
Properties
|
For information on utilizing OAuth client authorization, see our authentication documentation or the Client Credentials Grant section of the [OAuth spec](https://tools.ietf.org/html/draft-ietf-oauth-v2-31.
Name | Data Type | Description |
---|---|---|
|
object |
scope
|
string |
A space-separated list of the authentication scopes that you want to access. The default is public |
grant_type
|
string Allowed values: - client_credentials |
The grant type. Must be set to |
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
token_secret
|
string |
The OAuth 1 token secret. Examples:NTgwMzdjMDA3OGQ1ZjU0ZTE1ZTYzOGNjMGRkODgyYTU3MGIxM2M1MA== |
token
|
string |
The OAuth 1 token. Examples:58037c0078d5f54e15e638cc0dd882a570b13c50 |
grant_type
|
string Allowed values: - vimeo_oauth1 |
The grant type. Must be set to |
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth-error | |||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method enables an app to notify the API that it is done with a token and that the token can be discarded.
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
auth | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - followers - videos |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [channel] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
category | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method gets all existing categories.
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - last_video_featured_time - name |
The way to sort the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [category] | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - members - videos |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [group] | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
category
|
double |
The name of the category. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - name |
The way to sort the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [category] | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
category
|
double |
The name of the category. |
Name | Data Type | Description |
---|---|---|
user_id
|
double |
The ID of the user. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - date - name |
The way to sort the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [category] | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
category
|
string |
The name of the category. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
video | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
category
|
string |
The name of the category. |
Name | Data Type | Description |
---|---|---|
sort
|
string Allowed values: - alphabetical - comments - date - duration - featured - likes - plays - relevant |
The way to sort the results. |
query
|
string |
The search query to use to filter the results. |
per_page
|
double |
The number of items to show on each page of results, up to a maximum of 100. |
page
|
double |
The page number of the results to show. |
filter_embeddable
|
boolean |
Whether to filter the results by embeddable videos ( |
filter
|
string Allowed values: - conditional_featured - embeddable |
The attribute by which to filter the results. Option descriptions:
|
direction
|
string Allowed values: - asc - desc |
The sort direction of the results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [video] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
array [category] | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
With this method, you can suggest up to two categories and one subcategory for a video. Vimeo makes the final determination about whether the video belongs in these categories.
Name | Data Type | Description |
---|---|---|
video_id
|
double |
The ID of the video. |
Name | Data Type | Description |
---|---|---|
|
object |
category
|
array [string] |
The array of the names of the categories that you're suggesting. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
category | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method removes a single category from the specified channel.
Name | Data Type | Description |
---|---|---|
channel_id
|
double |
The ID of the channel. |
category
|
string |
The name of the category. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method adds a channel to a category.
Name | Data Type | Description |
---|---|---|
channel_id
|
double |
The ID of the channel. |
category
|
string |
The name of the category. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
error | |||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
legacy-error | ||||||||
Properties
|
This method gets all the categories in the specified channel.
Name | Data Type | Description |
---|---|---|
channel_id
|
double |
The ID of the channel. |
Name | Data Type | Description | |
---|---|---|---|
|
array [category] | ||
|