Endpoints

Choose your endpoint

Each HTTP request consists of an HTTP Method, an endpoint and a list of parameters. Throughout the documentation, these requests are formatted like the following example.


{METHOD} https://api.vimeo.com{endpoint}
This method requires a token with the "{scope_name}" scope.
Field Required Description
{field1} Yes Description of field1
{field2} No Description of field2
  1. Method

    Most of Vimeo's API endpoints support multiple actions. Each action is defined by it's HTTP method. These methods generally follow the guidelines below.

    METHOD Description Example
    GET Retrieve the JSON representation of a resource GET /me returns the authenticated user's information
    POST Add new resources to a collection. This method generally requires additional parameters POST /me/albums has the authenticated user creates a new album
    PUT Replace a resource or connect two resources together PUT /me/likes/[video_id] adds a "like" to [video_id] on behalf of the authenticated user
    PATCH Modify a resource. The body will contain the new resource representation. PATCH /videos/[video_id] allows you to change fields of the video [video_id]
    DELETE Delete an existing resource, or disconnect two resources DELETE /videos/[video_id] deletes the video [video_id]
  2. Endpoint

    An API endpoint is a path that uniquely identifies a Vimeo resource. To make an HTTP request to an endpoint, append this path to the end of https://api.vimeo.com. The response from an endpoint will be JSON, and contain one or more resources.


  3. Parameters

    Most API Endpoints support additional request parameters. These parameters depend on your HTTP method and your API endpoint.

    GET

    All GET requests must append the parameters to the endpoint as is true for any standard query component.


    METHOD endpoint?field1=hello&field2=goodbye

    POST, PUT, DELETE, PATCH

    All other requests must provide the parameters through the body. By default we assume you are sending the value as application/x-www-form-urlencoded.


    METHOD endpoint
    Content-Type: application/x-www-form-urlencoded
    
    field1=hello&field2=goodbye

    We also accept JSON if you provide a Content-Type header of application/json.

    METHOD endpoint
    Content-Type: application/json
    
    { "field1": "hello", "field2": "goodbye" }

    Urlencoded nested parameters are represented in the documentation with dot notation.

    METHOD endpoint
    Content-Type: application/x-www-form-urlencoded
    
    privacy.view=anybody

    When using JSON, these fields must be nested JSON objects.

    METHOD endpoint
    Content-Type: application/json
    
    { "privacy": { "view" : "anybody" } }

  4. Learn more

    Want to learn more about using the Vimeo API? Check out the rest of our documentation

Send Feedback