Vimeo

GET

/

Get an API specification

Request

Query

Name	Data Type	Description
`openapi`	boolean	Return an OpenAPI specification.

Responses

200Standard request.

Body

Name Data Type Description

endpoint

Endpoint object

Properties

`path`	string	The path section of the URL, which, when appended to the API host `https:///api.vimeo.com`, builds a full API endpoint. Examples: /me
`methods`	array [string]	All HTTP methods permitted on this endpoint.

DELETE

/me/albums/{album_id}/videos/{video_id}

Remove a video from an album

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.
`album_id`	double	The ID of the album.

Responses

204The video was removed.

403The supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/me/albums/{album_id}/videos/{video_id}

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

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.
`album_id`	double	The ID of the album.

Query

Name	Data Type	Description
`password`	string	The password of the album.

Responses

200The video was returned.

Body

Name Data Type Description

video

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such album exists, or the video wasn't found in it.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/me/albums/{album_id}/videos/{video_id}

Add a specific video to an album

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.
`album_id`	double	The ID of the album.

Responses

204The video was added.

403The supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/me/albums/{album_id}/videos

Get all the videos in an album

Request

Path

Name	Data Type	Description
`album_id`	double	The ID of the album.

Query

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 (`true`) or non-embeddable videos (`false`). Required only if filter is `embeddable`.
`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.

Responses

200The videos were returned.

Body

Name Data Type Description

array [video]

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/me/albums/{album_id}/videos

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

Request

Path

Name	Data Type	Description
`album_id`	double	The ID of the album.

Body

Name	Data Type	Description
	object

Properties


                        videos

string

A comma-separated list of video URIs.

Examples:

/videos/258684937,/videos/273576296

Responses

201The videos were added.

403The authenticated user can't add videos to albums.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/users/{user_id}/albums/{album_id}/videos/{video_id}

Remove a video from an album

Request

Path

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.

Responses

204The video was removed.

403The supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/videos/{video_id}

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

Request

Path

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.

Query

Name	Data Type	Description
`password`	string	The password of the album.

Responses

200The video was returned.

Body

Name Data Type Description

video

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such album exists, or the video wasn't found in it.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/users/{user_id}/albums/{album_id}/videos/{video_id}

Add a specific video to an album

Request

Path

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.

Responses

204The video was added.

403The supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/videos

Get all the videos in an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Query

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 (`true`) or non-embeddable videos (`false`). Required only if filter is `embeddable`.
`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.

Responses

200The videos were returned.

Body

Name Data Type Description

array [video]

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/users/{user_id}/albums/{album_id}/videos

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

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Body

Name	Data Type	Description
	object

Properties


                        videos

string

A comma-separated list of video URIs.

Examples:

/videos/258684937,/videos/273576296

Responses

201The videos were added.

403The authenticated user can't add videos to albums.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/users/{user_id}/albums/{album_id}/logos/{logo_id}

This method removes a custom logo from the specified album.

Request

Path

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.

Responses

204The custom logo was removed.

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom logo.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/logos/{logo_id}

Get a specific custom album logo

Request

Path

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.

Responses

200The custom logo was returned.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't view this custom logo.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom logo.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PATCH

/users/{user_id}/albums/{album_id}/logos/{logo_id}

Replace a custom album logo

Request

Path

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.

Body

Name	Data Type	Description
	object

Properties


                        active

boolean

Whether to make this the active album logo.

Examples:

true

Responses

200The custom logo was replaced.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom logo.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/logos

Get all the custom logos of an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Query

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.

Responses

200The custom logos were returned.

Body

Name Data Type Description

array [picture]

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

POST

/users/{user_id}/albums/{album_id}/logos

Add a custom album logo

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Responses

201The logo was added to the album.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

This method removes a custom uploaded thumbnail from the specified album.

Request

Path

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.

Responses

204The custom thumbnail was removed.

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom thumbnail.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

Get a specific custom uploaded album thumbnail

Request

Path

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.

Responses

200The custom thumbnail was returned.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't view this custom thumbnail.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom thumbnail.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PATCH

/users/{user_id}/albums/{album_id}/custom_thumbnails/{thumbnail_id}

Replace a custom uploaded album thumbnail

Request

Path

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.

Body

Name	Data Type	Description
	object

Properties


                        active

boolean

Whether to make this the active album thumbnail.

Examples:

true

Responses

200The custom thumbnail was replaced.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists, or it doesn't contain the specified custom thumbnail.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}/custom_thumbnails

Get all the custom upload thumbnails of an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Query

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.

Responses

200The custom uploaded thumbnails were returned.

Body

Name Data Type Description

array [picture]

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

POST

/users/{user_id}/albums/{album_id}/custom_thumbnails

Add a custom uploaded thumbnail

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Responses

201The custom thumbnail was added to the album.

Body

Name Data Type Description

picture

Picture object

Properties

`uri`	string	The picture's URI. Examples: /users/152184/pictures/12345
`type`	string Allowed values: - `caution` - `custom` - `default`	The type of the picture: Option descriptions: `caution` - An image that is appropriate for all ages. `custom` - A custom image for the video. `default` - The default image for the video. Examples: caution
`sizes`	array [object]	An array containing reference information about all available image files.
`resource_key`	string	The picture's resource key string. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`link`	string	The upload URL for the picture. This field appears when you create the picture resource for the first time.
`active`	boolean	Whether this picture is the active picture for its parent resource. Examples: true

403The authenticated user can't modify this album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/me/albums/{album_id}

Delete an album

Request

Path

Name	Data Type	Description
`album_id`	double	The ID of the album.

Responses

204The album was deleted.

403The supplied token doesn't have the proper scopes, or the authenticated user can't delete the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/me/albums/{album_id}

Get a specific album

Request

Path

Name	Data Type	Description
`album_id`	double	The ID of the album.

Responses

200The album was returned.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PATCH

/me/albums/{album_id}

Edit an album

Request

Path

Name	Data Type	Description
`album_id`	double	The ID of the album.

Body

Name	Data Type	Description
	object

Properties

`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 `password`. Examples: 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

Responses

200The album was edited.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

403The authenticated user doesn't own the album, the supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/me/albums

Get all the albums that belong to a user

Request

Query

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.

Responses

200The albums were returned.

Body

Name Data Type Description

array [album]

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

POST

/me/albums

Create an album

Request

Body

Name	Data Type	Description
	object

Properties

`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 `password`. Examples: 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

Responses

201The album was created.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

403The supplied token doesn't have the proper scopes, or the authenticated user can't create an album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/users/{user_id}/albums/{album_id}

Delete an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Responses

204The album was deleted.

403The supplied token doesn't have the proper scopes, or the authenticated user can't delete the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums/{album_id}

Get a specific album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Responses

200The album was returned.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PATCH

/users/{user_id}/albums/{album_id}

Edit an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.
`album_id`	double	The ID of the album.

Body

Name	Data Type	Description
	object

Properties

`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 `password`. Examples: 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

Responses

200The album was edited.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

403The authenticated user doesn't own the album, the supplied token doesn't have the proper scopes, or the authenticated user can't edit the album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such album exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/users/{user_id}/albums

Get all the albums that belong to a user

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.

Query

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.

Responses

200The albums were returned.

Body

Name Data Type Description

array [album]

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

POST

/users/{user_id}/albums

Create an album

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.

Body

Name	Data Type	Description
	object

Properties

`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 `password`. Examples: 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

Responses

201The album was created.

Body

Name Data Type Description

album

Album object

Properties

`web_custom_logo`	boolean	Whether an album's custom logo should be shown in the web layout. Examples: true
`web_brand_color`	boolean	Whether an album should show the brand color in the web layout. Examples: true
`user`		The owner of the album.
`use_custom_domain`	boolean	Whether the user has opted in to use a custom domain for their album. Examples: false
`url`	string	The custom Vimeo URL a user has selected for their album. Examples: my-custom-url
`uri`	string	The album's URI. Examples: /albums/3706071
`theme`	string Allowed values: - `dark` - `standard`	The album's color theme preference Examples: dark
`sort`	string Allowed values: - `added_first` - `added_last` - `alphabetical` - `arranged` - `comments` - `likes` - `newest` - `oldest` - `plays`	Sort type of the album. Examples: added_first
`review_mode`	boolean	Whether album videos should use the review mode URL. Examples: true
`resource_key`	string	The album resource key. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`privacy`
`pictures`		The active image for the album; defaults to the thumbnail of the last video added to the album.
`name`	string	The album's display name. Examples: Vimeo Holiday Videos!
`modified_time`	string	The time in ISO 8601 format when the album was last modified. Examples: 2018-02-06T21:24:17+00:00
`metadata`
`link`	string	The URL to access the album. Examples: https://vimeo.com/album/Vimeo Holiday Videos!
`layout`	string Allowed values: - `grid` - `player`	The album's layout preference Examples: grid
`hide_vimeo_logo`	boolean	Whether to hide the Vimeo logo in the player of the album's embedded playlist. Examples: true
`hide_nav`	boolean	Whether to hide the Vimeo navigation when viewing the album. Examples: true
`embed_custom_logo`	boolean	Whether to show the album's custom logo in the player of the album's embedded playlist. Examples: true
`embed_brand_color`	boolean	Whether to show the album's custom brand color in the player of the album's embedded playlist. Examples: true
`embed`
`duration`	double	The total duration in seconds of all the videos in the album. Examples: 1163
`domain`	string	The custom domain a user has selected for their album. Examples: mycustomdomain.com
`description`	string	A brief description of the album's content. Examples: Vimeo holiday videos!
`custom_logo`		The custom logo for this album.
`created_time`	string	The time in ISO 8601 format that the album was created. Examples: 2015-12-17T21:32:44+00:00
`brand_color`	string	Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons. Examples: ff66ee
`allow_share`	boolean	Whether an album should allow sharing. Examples: true
`allow_downloads`	boolean	Whether an album should allow downloads. Examples: true
`allow_continuous_play`	boolean	Whether an album should allow continuous play. Examples: true

400A parameter is invalid.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

403The supplied token doesn't have the proper scopes, or the authenticated user can't create an album.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

POST

/oauth/access_token

Exchange an authorization code for an access token

Request

Body

Name	Data Type	Description
	object

Properties

`redirect_uri`	string	The redirect URI. Must match the URI from `/oauth/authorize`. Examples: https://example.com
`grant_type`	string Allowed values: - `authorization_code`	The grant type. Must be set to `authorization_code`.
`code`	string	The authorization code received from the authorization server. Examples: 1234abcd

Responses

200The authorization code was exchanged.

Body

Name Data Type Description

auth

Auth object

Properties

`user`		The user associated with the token.
`token_type`	string Allowed values: - `bearer`	The token type: Option descriptions: `bearer` - The token is of the `bearer` type. Examples: bearer
`scope`	string	The scope or scopes that the token supports. Examples: private create edit upload public
`refresh_token`	string	The refresh token string. Examples: 3d3bc8a9cb7debfd01b270e419b2d265983362f9
`expires_on`	string	The date and time that the token expires. Examples: 1495048954
`app`		The API application associated with the token.
`access_token`	string	The access token string. Examples: 01019a4a62aec63db077317ab7bb429db75652401e

400There are three ways that this status code can be encountered: * The grant type is invalid. * The authorization code is invalid. * The redirect URI does not match the URI to create the authorization code.

Body

Name Data Type Description

auth-error

Auth Error object

Properties

`error_description`	string	The description of the error. Examples: An error has occurred on Vimeo's servers. Please try again.
`error`	string	The name of the error. Examples: server_error

POST

/oauth/authorize/client

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.

Request

Body

Name	Data Type	Description
	object

Properties

`scope`	string	A space-separated list of the authentication scopes that you want to access. The default is `public`. Examples: public
`grant_type`	string Allowed values: - `client_credentials`	The grant type. Must be set to `client_credentials`.

Responses

200The authorization was successful.

Body

Name Data Type Description

auth

Auth object

Properties

`user`		The user associated with the token.
`token_type`	string Allowed values: - `bearer`	The token type: Option descriptions: `bearer` - The token is of the `bearer` type. Examples: bearer
`scope`	string	The scope or scopes that the token supports. Examples: private create edit upload public
`refresh_token`	string	The refresh token string. Examples: 3d3bc8a9cb7debfd01b270e419b2d265983362f9
`expires_on`	string	The date and time that the token expires. Examples: 1495048954
`app`		The API application associated with the token.
`access_token`	string	The access token string. Examples: 01019a4a62aec63db077317ab7bb429db75652401e

401If client secret was not found. Returns a unique error code of `8001`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

POST

/oauth/authorize/vimeo_oauth1

Convert OAuth 1 access tokens to OAuth 2 access tokens

Request

Body

Name	Data Type	Description
	object

Properties

`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 `vimeo_oauth1`.

Responses

200The tokens were converted.

Body

Name Data Type Description

auth

Auth object

Properties

`user`		The user associated with the token.
`token_type`	string Allowed values: - `bearer`	The token type: Option descriptions: `bearer` - The token is of the `bearer` type. Examples: bearer
`scope`	string	The scope or scopes that the token supports. Examples: private create edit upload public
`refresh_token`	string	The refresh token string. Examples: 3d3bc8a9cb7debfd01b270e419b2d265983362f9
`expires_on`	string	The date and time that the token expires. Examples: 1495048954
`app`		The API application associated with the token.
`access_token`	string	The access token string. Examples: 01019a4a62aec63db077317ab7bb429db75652401e

400There are two ways that this status code can be encountered: * The token is invalid. * The token has unauthorized scopes.

Body

Name Data Type Description

auth-error

Auth Error object

Properties

`error_description`	string	The description of the error. Examples: An error has occurred on Vimeo's servers. Please try again.
`error`	string	The name of the error. Examples: server_error

GET

/oauth/verify

Verify an OAuth 2 token

Responses

200The token was verified.

Body

Name Data Type Description

auth

Auth object

Properties

`user`		The user associated with the token.
`token_type`	string Allowed values: - `bearer`	The token type: Option descriptions: `bearer` - The token is of the `bearer` type. Examples: bearer
`scope`	string	The scope or scopes that the token supports. Examples: private create edit upload public
`refresh_token`	string	The refresh token string. Examples: 3d3bc8a9cb7debfd01b270e419b2d265983362f9
`expires_on`	string	The date and time that the token expires. Examples: 1495048954
`app`		The API application associated with the token.
`access_token`	string	The access token string. Examples: 01019a4a62aec63db077317ab7bb429db75652401e

401The token is not a valid OAuth 2 token.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/tokens

This method enables an app to notify the API that it is done with a token and that the token can be discarded.

Responses

204The token was revoked.

Body

Name Data Type Description

auth

Auth object

Properties

`user`		The user associated with the token.
`token_type`	string Allowed values: - `bearer`	The token type: Option descriptions: `bearer` - The token is of the `bearer` type. Examples: bearer
`scope`	string	The scope or scopes that the token supports. Examples: private create edit upload public
`refresh_token`	string	The refresh token string. Examples: 3d3bc8a9cb7debfd01b270e419b2d265983362f9
`expires_on`	string	The date and time that the token expires. Examples: 1495048954
`app`		The API application associated with the token.
`access_token`	string	The access token string. Examples: 01019a4a62aec63db077317ab7bb429db75652401e

400You cannot revoke access for an OAuth 1 token.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/categories/{category}/channels

Get all the channels in a category

Request

Path

Name	Data Type	Description
`category`	string	The name of the category.

Query

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.

Responses

200The channels were returned.

Body

Name Data Type Description

array [channel]

Channel object

Properties


                        user

The Vimeo user who owns the channel.

uri

string

The unique identifier to access the channel resource.

Examples:

/channels/927


                        tags

array [tag]

An array of all tags assigned to this channel.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        resource_key

string

The channel resource key.

Examples:

e5595241643259c658ed6c85ca82985a6341edc7

privacy


                        pictures

The active image for the channel; defaults to the thumbnail of the last video added to the channel.


                        name

string

The display name that identifies the channel.

Examples:

Vimeo Staff Picks


                        modified_time

string

The time in ISO 8601 format when the album was last modified.

Examples:

2018-03-21T22:52:29+00:00

metadata


                        link

string

The URL to access the channel in a browser.

Examples:

https://vimeo.com/channels/staffpicks


                        header

The banner that appears by default at the top of the channel page.


                        description

string

A brief explanation of the channel's content.

Examples:

We really love videos, and these are the videos we really, really love.


                        created_time

string

The time in ISO 8601 format when the channel was created.

Examples:

2007-10-23T17:00:43+00:00


                        categories

array [category]

The categories to which this channel belongs as specified by the channel moderators.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/categories/{category}

Get a specific category

Request

Path

Name	Data Type	Description
`category`	string	The name of the category.

Responses

200The category was returned.

Body

Name Data Type Description

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/categories

This method gets all existing categories.

Request

Query

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.

Responses

200The categories were returned.

Body

Name Data Type Description

array [category]

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

GET

/categories/{category}/groups

Get all the groups in a category

Request

Path

Name	Data Type	Description
`category`	string	The name of the category.

Query

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.

Responses

200The groups were returned.

Body

Name Data Type Description

array [group]

Group object

Properties

`user`		The owner of the group.
`uri`	string	The canonical relative URI of this group. Examples: /groups/1108
`resource_key`	string	The resource key of the group. Examples: dc724af18fbdd4e59189f5fe768a5f8311527050
`privacy`
`pictures`		The active picture for this group.
`name`	string	The group's display name. Examples: Vimeo Weekend Challenge
`modified_time`	string	The time in ISO 8601 format when the group was last modified. Examples: 2018-09-16T15:41:45+00:00
`metadata`
`link`	string	The link to the group. Examples: https://vimeo.com/groups/weekendchallenge
`description`	string	The group's description. Examples: Want to participate in our weekly Challenges? Join the Group to receive messages and new Challenges!
`created_time`	string	The time in ISO 8601 format when the group was created. Examples: 2008-07-05T14:52:43+00:00

404No such category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/me/categories/{category}

GET

/me/categories/{category}

PUT

/me/categories/{category}

GET

/me/categories

Get all the categories that a user follows

Request

Query

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.

Responses

200The categories were returned.

Body

Name Data Type Description

array [category]

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

403You cannot view another user. Returns a unique error code of `3200`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

DELETE

/users/{user_id}/categories/{category}

GET

/users/{user_id}/categories/{category}

PUT

/users/{user_id}/categories/{category}

GET

/users/{user_id}/categories

Get all the categories that a user follows

Request

Path

Name	Data Type	Description
`user_id`	double	The ID of the user.

Query

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.

Responses

200The categories were returned.

Body

Name Data Type Description

array [category]

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

403You cannot view another user. Returns a unique error code of `3200`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

GET

/categories/{category}/videos/{video_id}

Check for a video in a category

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.
`category`	string	The name of the category.

Responses

200The video belongs to the category.

Body

Name Data Type Description

video

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such category exists, or the video doesn't belong to it.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/categories/{category}/videos

Get all the videos in a category

Request

Path

Name	Data Type	Description
`category`	string	The name of the category.

Query

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 (`true`) or non-embeddable videos (`false`). Required only if filter is `embeddable`.
`filter`	string Allowed values: - `conditional_featured` - `embeddable`	The attribute by which to filter the results. Option descriptions: `conditional_featured` - Featured (promoted) videos
`direction`	string Allowed values: - `asc` - `desc`	The sort direction of the results.

Responses

200The videos were returned.

Body

Name Data Type Description

array [video]

Video object

Properties


                        width

double

The video's width in pixels.

Examples:


                        user

The video owner.

uri

string

The video's canonical relative URI.

Examples:

/videos/258684937

upload

transcode


                        tags

array [tag]

An array of all tags assigned to this video.

Tag object

Properties

`uri`	string	The canonical relative URI of the tag. Examples: /videos/258684937/tags/awesome
`resource_key`	string	The tag's resource key string. Examples: bac1033deba2310ebba2caec33c23e4beea67aba
`name`	string	The tag value. Examples: awesome
`metadata`
`canonical`	string	The normalized canonical tag name. Examples: awesome


                        status

string
Allowed values:
- available
- quota_exceeded
- total_cap_exceeded
- transcode_starting
- transcoding
- transcoding_error
- unavailable
- uploading
- uploading_error

The status code for the availability of the video. This field is deprecated in favor of upload and transcode.

Option descriptions:

available - The video is available.
quota_exceeded - The user's quota is exceeded with this video.
total_cap_exceeded - The user has exceeded their total cap with this video.
transcode_starting - Transcoding is beginning for the video.
transcoding - Transcoding is underway for the video.
transcoding_error - There was an error in transcoding the video.
unavailable - The video is unavailable.
uploading - The video is being uploaded.
uploading_error - There was an error in uploading the video.

Examples:

available

stats

spatial


                        resource_key

string

The resource key string of the video.

Examples:

bac1033deba2310ebba2caec33c23e4beea67aba


                        release_time

string

The time in ISO 8601 format when the video was released.

Examples:

2018-03-05T21:04:47+00:00

privacy


                        pictures

The active picture for this video.


                        parent_folder

Information about the folder that contains this video.


                        name

string

The video's title.

Examples:

Celebrating 10 Years of Staff Picks


                        modified_time

string

The time in ISO 8601 format when the video metadata was last modified.

Examples:

2018-09-16T09:02:40+00:00

metadata


                        link

string

The link to the video.

Examples:

https://vimeo.com/258684937


                        license

string
Allowed values:
- by
- by-nc
- by-nc-nd
- by-nc-sa
- by-nd
- by-sa
- cc0

The Creative Commons license used for the video:

Option descriptions:

by - Attribution
by-nc - Attribution Non-Commercial
by-nc-nd - Attribution Non-Commercial No Derivatives
by-nc-sa - Attribution Non-Commercial Share Alike
by-nd - Attribution No Derivatives
by-sa - Attribution Share Alike
cc0 - Public Domain Dedication

Examples:

by


                        last_user_action_event_date

string

The time in ISO 8601 format when the user last modified the video.

Examples:

2018-03-21T23:08:22+00:00


                        language

string

The video's primary language.

Examples:

en-US


                        height

double

The video's height in pixels.

Examples:


                        embed

Information about embedding this video.


                        duration

double

The video's duration in seconds.

Examples:


                        description

string

A brief explanation of the video's content.

Examples:

A celebration of 10 years of Staff Picks.


                        created_time

string

The time in ISO 8601 format when the video was created.

Examples:

2018-03-05T21:04:47+00:00

context


                        content_rating

array [string]

The content ratings of this video.


                        categories

array [category]

The categories to which this video belongs.

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/videos/{video_id}/categories

Get all the categories to which a video belongs

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.

Responses

200The categories were returned.

Body

Name Data Type Description

array [category]

Category object

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

404No such video exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/videos/{video_id}/categories

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.

Request

Path

Name	Data Type	Description
`video_id`	double	The ID of the video.

Body

Name	Data Type	Description
	object

Properties


                        category

array [string]

The array of the names of the categories that you're suggesting.

Responses

201The categories were suggested.

Body

Name Data Type Description

Properties

`uri`	string	The unique identifier to access the category resource. Examples: /categories/animation
`top_level`	boolean	Whether the category is not a subcategory of another category. Examples: true
`subcategories`	array [object]	All the subcategories that belong to this category, if the current category is a top-level parent.
`resource_key`	string	The resource key of the category. Examples: e5595241643259c658ed6c85ca82985a6341edc7
`pictures`		The active picture for this category; defaults to vertical color bars.
`parent`
`name`	string	The display name that identifies the category. Examples: Animation
`metadata`
`link`	string	The URL to access the category in a browser. Examples: https://vimeo.com/categories/animation
`last_video_featured_time`	string	The last time, in ISO 8601 format, that a video was featured. Examples: 2017-05-17T17:46:09+00:00
`icon`		The active icon for the category.

403You don't own this video.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

404No such video exists, or no such category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

DELETE

/channels/{channel_id}/categories/{category}

This method removes a single category from the specified channel.

Request

Path

Name	Data Type	Description
`channel_id`	double	The ID of the channel.
`category`	string	The name of the category.

Responses

204The channel was removed.

401The user credentials are invalid. Returns a unique error code of `8003`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

403The authenticated user doesn't own the channel or isn't a channel moderator. Returns a unique error code of `3200`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

404No such channel or category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

PUT

/channels/{channel_id}/categories/{category}

This method adds a channel to a category.

Request

Path

Name	Data Type	Description
`channel_id`	double	The ID of the channel.
`category`	string	The name of the category.

Responses

204The channel was categorized.

400You exceeded the maximum number of channel categories. Returns a unique error code of `2204`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

401The user credentials are invalid. Returns a unique error code of `8003`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

403The authenticated user doesn't own the channel or isn't a channel moderator. Returns a unique error code of `3200`.

Body

Name Data Type Description

error

Error object

Properties

`link`	string	A link to more information about the error.
`error_code`	double	The error code. Examples: 5000
`error`	string	The error message that non-developer users receive. Examples: Something strange occurred. Please try again.
`developer_message`	string	The error message that developers receive. Examples: The specified resource does not exist.

404No such channel or category exists.

Body

Name Data Type Description

legacy-error

Legacy Error object

Properties


                        error

string

User-friendly error message

Examples:

Something strange occurred. Please try again.

GET

/channels/{channel_id}/categories

Resources

API Information

Request

Query

Responses

Body

Properties

Albums\Album videos

Request

Path

Responses

Body

Properties

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Body

Properties

Request

Path

Responses

Body

Properties

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Body

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Body

Properties

Request

Path

Responses

Body

Properties

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Body

Properties

Request

Path

Responses

Body

Properties

Body

Properties

Request

Path

Query

Responses