How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vimeo OTT Customers API

Subscribers, their product access, watchlists, and in-progress viewing.

Vimeo OTT Customers API is one of 6 APIs that Vimeo OTT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.vhx.tv.

10 operations 5 paths 8 schemas 2 DELETE4 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.vhx.tv
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Vimeo OTT Customers API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Auth. Supply your Vimeo OTT API key as the username and leave the password blank.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 10

Subscribers, their product access, watchlists, and in-progress viewing.

GET
/customers
List customers
listCustomers 3 params → 200401
POST
/customers
Create a customer
createCustomer body → 201400401429
GET
/customers/{id}
Retrieve a customer
getCustomer 1 param → 200401404
PUT
/customers/{id}
Update a customer
updateCustomer 1 param body → 200401404
PUT
/customers/{id}/products
Grant product access
addCustomerProduct 1 param body → 200401404
DELETE
/customers/{id}/products
Revoke product access
removeCustomerProduct 2 params → 204401404
GET
/customers/{id}/watchlist
Retrieve a customer's watchlist
getCustomerWatchlist 1 param → 200401
PUT
/customers/{id}/watchlist
Add to watchlist
addToWatchlist 1 param body → 200401
DELETE
/customers/{id}/watchlist
Remove from watchlist
removeFromWatchlist 2 params → 204401
GET
/customers/{id}/watching
Retrieve in-progress videos
getCustomerWatching 1 param → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Customer (10 properties), Video (9 properties), CustomerList (4 properties), CustomerCreate (4 properties). Each schema is shown below with its type and property counts.

VideoList
object
4 properties
CustomerUpdate
object
2 properties
Customer
object
10 properties
Links
object
HAL hypermedia links.
Video
object
9 properties
CustomerCreate
object
4 properties 3 required
Error
object
2 properties
CustomerList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vimeo-ott-customers-api-openapi.yml Raw ↑

Other APIs Vimeo OTT publishes across the network.

Vimeo OTT Analytics API
Vimeo OTT Authorizations API
Vimeo OTT Collections API
Vimeo OTT Products API
Vimeo OTT Videos API
Where this information came from

This is an independent, third-party profile of Vimeo OTT Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.