api.vimeo.com/ondemand

Genres

View one genre

GET https://api.vimeo.com/ondemand/genres/{genre_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand genre cannot be found

View all genres

GET https://api.vimeo.com/ondemand/genres Playground
HTTP Status Code Explanation
200 OK

Pages

Check for a page

GET https://api.vimeo.com/ondemand/genres/{genre_id}/pages/{ondemand_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found in the On Demand genre

View all pages

GET https://api.vimeo.com/ondemand/genres/{genre_id}/pages Playground
Name Type Required Description
filter string
  • country
  • my_region
No

Filter to apply to the results.

sort string
  • name
  • publish.time
  • videos
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Pages

View one page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Edit one page

PATCH https://api.vimeo.com/ondemand/pages/{ondemand_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
link string No

The custom string to use in this On Demand page's Vimeo URL.

preorder.active boolean No

If set to true, you will enable pre-orders on the On Demand page

preorder.publish_time boolean No

Required if preorder.active is true. The time that the On Demand page will be published

publish.active boolean No

If set to true, you will publish the On Demand page

publish_when_ready boolean No

This On Demand page will be automatically published when all videos are finished transcoding

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If the authenticated user does not have permission to edit the On Demand page.

Delete one page

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id} Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

400 Bad Request

If you are attempting to remove the final On Demand genre from a page.

Background Images

View a Background

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds/{background_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Image cannot be found

403 Forbidden

If you are viewing another users On Demand Page background.

Edit a background

PATCH https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds/{background_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
active boolean Yes

Set this background as the active background

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Image cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

Delete a background

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds/{background_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Image cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own

Get backgrounds

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Create a background

POST https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found

403 Forbidden

If you are modifying another users On Demand Page.

Genres

Check a page's genre

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/genres/{genre_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the On Demand genre cannot be found in the On Demand page

Assign a Genre

PUT https://api.vimeo.com/ondemand/pages/{ondemand_id}/genres/{genre_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
201 Created

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

400 Bad Request

If you attempt to add more than 2 genres to an On Demand page.

Unassign a genre

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/genres/{genre_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Genre cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

400 Bad Request

If you are attempting to remove the final On Demand genre from a page.

View genres for a page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/genres Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Likes

Get a list of users who liked videos in an On Demand page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/likes Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • extra
  • main
  • trailer
No

Filter to apply to the results.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • alphabetical
  • date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Pictures

View a poster

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/pictures/{poster_id} Playground
HTTP Status Code Explanation
200 OK

Edit a poster

PATCH https://api.vimeo.com/ondemand/pages/{ondemand_id}/pictures/{poster_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
active boolean Yes

Set this picture as the active picture.

HTTP Status Code Explanation
200 OK

View all posters

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/pictures Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Add a poster

POST https://api.vimeo.com/ondemand/pages/{ondemand_id}/pictures Playground
This method requires a token with the "upload" scope.
HTTP Status Code Explanation
201 Created

403 Forbidden

If you are modifying another users On Demand Page.

Promotions

View promotion

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions/{promotion_id} Playground
This method requires a token with the "promo_codes" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the Promotion cannot be found

403 Forbidden

If you are attempting to view a promotion for an On Demand page you do not own.

Delete promotion

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions/{promotion_id} Playground
This method requires a token with the "promo_codes" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the Promotion cannot be found

403 Forbidden

If you are attempting to delete a promotion for an On Demand page you do not own.

View promotions for a page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions Playground
This method requires a token with the "promo_codes" scope.
Name Type Required Description
filter string
  • batch
  • default
  • single
  • vip
No

Filter to apply to the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If you are attempting to view promotions for an On Demand page you do not own.

400 Bad Request

If an invalid filter was supplied.

Add promotion

POST https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions Playground
This method requires a token with the "promo_codes" scope.
Name Type Required Description
access_type string
  • default
  • vip
No

"default" promotions grant discount on the existing purchase options for an On Demand Container. "vip" promotions can be used to grant free access to vod content before it is released, or to offer a purchase option that is not available on the container. "vip" promotions will always make the content free, and must be further defined with the download or stream_period fields.

code string Yes

If you are only creating a single promotion code, you can provide the value here. This field will be rejected for batch promotions.

discount_type string
  • free
  • percent
No

Describes the type of discount offered by this promo code. Defaults to "free". "percent" reduces the price by an amount defined in the "percentoff" field. "free" reduces the price to zero. Note: When providing an accesstype of "vip", this field only accepts the "free" discount_type.

download boolean Yes

Whether this promotion grants download access to vod content. This is only necessary when not defined on the On Demand Container, and creating promotions with the "vip" accesstype and "buy" producttype

end_time timestamp No

The latest time this promotion is valid. If end_time is not specified, the promotion will never expire.

label string Yes

If you are creating a batch promotion, you can describe it here. This field will be rejected for single promotions.

percent_off integer Yes

The percentage saved by using this promo code. This field is required, and only applicable if the field discount_type is set to percent.

product_type string
  • any
  • buy
  • buy_episode
  • rent
  • rent_episode
  • subscribe
No

Restricts the promotion to a particular type of transaction. Defaults to "any" when accesstype is "default", and to "rent" if the accesstype is "vip". Only "buy" and "rent" are valid if the access_type is "vip".

start_time timestamp No

The earliest time this promotion is valid. If start_time is not specified, it will default to the time the promotion was created.

stream_period string
  • 1_week
  • 1_year
  • 24_hour
  • 30_day
  • 3_month
  • 48_hour
  • 6_month
  • 72_hour
Yes

The amount of time a user will have access to the vod content upon redeeming a promo code. This is only necessary when not defined on the On Demand Container, and creating promotions with the "vip" accesstype and "rent" producttype.

total integer Yes

Number of promotions to generate if type is batch. The amount of uses for the promotion if type is single.

type string
  • batch
  • single
Yes

type of promotions to use. "single" generates one promo code that can be used many times. "batch" generates many random promo codes with one use each. If the access type is vip, the only possible value for this field is batch.

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If you are attempting to create promotions for an On Demand page you do not own.

400 Bad Request

If errors exist in the request.

400 Bad Request

If that promo code already exists.

Promotion Codes

View all codes for a promotion

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions/{promotion_id}/codes Playground
This method requires a token with the "promo_codes" scope.
Name Type Required Description
page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

403 Forbidden

If you are attempting to create promotions for an On Demand page you do not own.

Regions

Check a page's region

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions/{country} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the On Demand Region cannot be found

Assign one region

PUT https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions/{country} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
201 Created

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the On Demand Region cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

Remove one region

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions/{country} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Region cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

View regions for page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Assign many regions

PUT https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the On Demand Region cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

Unassign many regions

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/regions Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand Page cannot be found

404 Not Found

If the On Demand Region cannot be found

403 Forbidden

If you are attempting to modify an On Demand page you do not own.

Seasons

Get a season of an On Demand Page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/seasons/{season_id} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

404 Not Found

If the On Demand season cannot be found in the On Demand page

View Seasons for this On Demand Page

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/seasons Playground
Name Type Required Description
direction string
  • asc
  • desc
No

The direction that the results are sorted.

filter string
  • viewable
No

Filter to apply to the results.

page integer No

The page number to show.

per_page integer No

Number of items to show on each page. Max 100.

query string No

Search query.

sort string
  • date
  • manual
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand page cannot be found

Videos

List all Videos

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/seasons/{season_id}/videos Playground
Name Type Required Description
filter string
  • viewable
No

Filter to apply to the results.

sort string
  • date
  • default
  • manual
  • name
  • purchase_time
  • release_date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

Videos

View a single video

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/videos/{video_id} Playground
HTTP Status Code Explanation
200 OK

If you're pulling the On Demand video object.

200 OK

Add a video

PUT https://api.vimeo.com/ondemand/pages/{ondemand_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
buy.price.AUD float No

The purchase price of this video in AUD.

buy.price.CAD float No

The purchase price of this video in CAD.

buy.price.CHF float No

The purchase price of this video in CHF.

buy.price.DKK float No

The purchase price of this video in DKK.

buy.price.EUR float No

The purchase price of this video in EUR.

buy.price.GBP float No

The purchase price of this video in GBP.

buy.price.JPY float No

The purchase price of this video in JPY.

buy.price.KRW float No

The purchase price of this video in KRW.

buy.price.NOK float No

The purchase price of this video in NOK.

buy.price.PLN float No

The purchase price of this video in PLN.

buy.price.SEK float No

The purchase price of this video in SEK.

buy.price.USD float No

The purchase price of this video. Required if buy.active is true.

position number No

The position this video will appear in this on demand's video collection.

release_year integer No

The video release year.

rent.price.AUD float No

The rental price of this video in AUD.

rent.price.CAD float No

The rental price of this video in CAD.

rent.price.CHF float No

The rental price of this video in CHF.

rent.price.DKK float No

The rental price of this video in DKK.

rent.price.EUR float No

The rental price of this video in EUR.

rent.price.GBP float No

The rental price of this video in GBP.

rent.price.JPY float No

The rental price of this video in JPY.

rent.price.KRW float No

The rental price of this video in KRW.

rent.price.NOK float No

The rental price of this video in NOK.

rent.price.PLN float No

The rental price of this video in PLN.

rent.price.SEK float No

The rental price of this video in SEK.

rent.price.USD float No

The rental price of this video in USD. Required if rent.active is true.

type string
  • extra
  • main
  • trailer
Yes

The type of video you are associating with the On Demand page

HTTP Status Code Explanation
200 OK

403 Forbidden

If you are not modifying your own On Demand Page.

400 Bad Request

If you are unable to add the video to this On Demand Page for any reason.

Disconnect a video

DELETE https://api.vimeo.com/ondemand/pages/{ondemand_id}/videos/{video_id} Playground
This method requires a token with the "edit" scope.
HTTP Status Code Explanation
204 No Content

403 Forbidden

If you are not modifying your own On Demand Page.

List all Videos

GET https://api.vimeo.com/ondemand/pages/{ondemand_id}/videos Playground
Name Type Required Description
filter string
  • all
  • buy
  • expiring_soon
  • extra
  • main
  • main.viewable
  • rent
  • trailer
  • unwatched
  • viewable
  • watched
No

Filter to apply to the results.

sort string
  • date
  • default
  • episode
  • manual
  • name
  • purchase_time
  • release_date
No

Technique used to sort the results.

HTTP Status Code Explanation
200 OK

If you're pulling the On Demand video object.

200 OK

Regions

View one region

GET https://api.vimeo.com/ondemand/regions/{country} Playground
HTTP Status Code Explanation
200 OK

404 Not Found

If the On Demand region cannot be found

View all regions

GET https://api.vimeo.com/ondemand/regions Playground
HTTP Status Code Explanation
200 OK

Send Feedback