VIvimeo
Embed Presets\Videos

Get all the videos that have been added to an embed preset

Changed on

This method returns all the videos that make use of the specified embed preset.

get/users/{user_id}/presets/{preset_id}/videos

Request

Path parameters

preset_idnumber required
Example:12345

The ID of the embed preset.

user_idnumber required
Example:152184

The ID of the user.

Query parameters

pagenumber
Example:1

The page number of the results to show.

per_pagenumber
Example:10

The number of items to show on each page of results, up to a maximum of 100.

Response

The videos were returned.

content_ratingstring[] required

The content ratings of this video.

created_timestring required

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

descriptionstring nullable required

A brief explanation of the video's content.

durationnumber required

The video's duration in seconds.

heightnumber required

The video's height in pixels.

languagestring nullable required

The video's primary language.

last_user_action_event_datestring nullable

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

license'by' | 'by-nc' | 'by-nc-nd' | 'by-nc-sa' | 'by-nd' | 'by-sa' | 'cc0' required

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
linkstring required

The link to the video.

modified_timestring required

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

namestring required

The video's title.

passwordstring

The privacy-enabled password to watch this video. Only users can see their own video passwords. This data requires a bearer token with the private scope.

release_timestring required

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

resource_keystring required

The resource key string of the video.

status'available' | 'quota_exceeded' | 'total_cap_exceeded' | 'transcode_starting' | 'transcoding' | 'transcoding_error' | 'unavailable' | 'uploading' | 'uploading_error' nullable required

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.
type'live' | 'stock' | 'video' required

The type of the video.

Option descriptions:

  • live - The video is or was a live event.
  • stock - The video is a Vimeo Stock video.
  • video - The video is a standard Vimeo video.
uristring required

The video's canonical relative URI.

widthnumber required

The video's width in pixels.

Example response

[
  {
    "categories": [
      {
        "icon": {
          "active": true,
          "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
          "sizes": [
            {
              "height": 720,
              "link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
              "link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
              "width": 1280
            }
          ],
          "type": "caution",
          "uri": "/users/152184/pictures/12345"
        },
        "last_video_featured_time": "2017-05-17T17:46:09+00:00",
        "link": "https://vimeo.com/categories/animation",
        "metadata": {
          "connections": {
            "channels": {
              "total": 90,
              "uri": "/categories/animation/channels"
            },
            "groups": {
              "total": 15,
              "uri": "/categories/animation/groups"
            },
            "users": {
              "total": 140,
              "uri": "/categories/animation/videos"
            },
            "videos": {
              "total": 960,
              "uri": "/categories/animation/videos"
            }
          },
          "interactions": {
            "follow": {
              "added": true,
              "added_time": "2017-05-17T17:46:09+00:00",
              "uri": "/users/152184/categories/animation"
            }
          }
        },
        "name": "Animation",
        "parent": {
          "link": "https://vimeo.com/categories/animation",
          "name": "Animation",
          "uri": "/categories/animation"
        },
        "pictures": {
          "active": true,
          "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
          "sizes": [
            {
              "height": 720,
              "link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
              "link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
              "width": 1280
            }
          ],
          "type": "caution",
          "uri": "/users/152184/pictures/12345"
        },
        "resource_key": "e5595241643259c658ed6c85ca82985a6341edc7",
        "subcategories": [
          {
            "link": "https://vimeo.com/categories/animation/2d/videos",
            "name": "2D",
            "uri": "/categories/animation/subcategories/2d"
          }
        ],
        "top_level": true,
        "uri": "/categories/animation"
      }
    ],
    "context": {
      "action": "Added to",
      "resource_type": "clip"
    },
    "created_time": "2018-03-05T21:04:47+00:00",
    "description": "A celebration of 10 years of Staff Picks.",
    "duration": 81,
    "embed": {
      "buttons": {
        "embed": true,
        "fullscreen": true,
        "hd": true,
        "like": true,
        "scaling": true,
        "share": true,
        "watchlater": true
      },
      "color": "#0a0808",
      "logos": {
        "custom": {
          "active": true,
          "link": "http://example.com",
          "sticky": true
        },
        "vimeo": true
      },
      "playbar": true,
      "speed": true,
      "title": {
        "name": "hide",
        "owner": "hide",
        "portrait": "hide"
      },
      "uri": "/videos/258684937/presets/12345",
      "volume": true
    },
    "height": 1080,
    "language": "en-US",
    "last_user_action_event_date": "2018-03-21T23:08:22+00:00",
    "license": "by",
    "link": "https://vimeo.com/258684937",
    "metadata": {
      "connections": {
        "available_albums": {
          "total": 14,
          "uri": "/videos/258684937/videos/available_albums"
        },
        "available_channels": {
          "total": 14,
          "uri": "/videos/258684937/videos/available_channels"
        },
        "comments": {
          "total": 14,
          "uri": "/videos/258684937/comments"
        },
        "credits": {
          "total": 4,
          "uri": "/videos/258684937/credits"
        },
        "likes": {
          "total": 230,
          "uri": "/videos/258684937/likes"
        },
        "ondemand": {
          "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
          "uri": "/ondemand/pages/61326"
        },
        "pictures": {
          "total": 1,
          "uri": "/videos/258684937/pictures"
        },
        "playback": {
          "uri": "/videos/258684937/playback"
        },
        "recommendations": {
          "uri": "/videos/258684937/recommendations"
        },
        "related": {
          "uri": "/videos/258684937?offset=10"
        },
        "season": {
          "name": "Season 1",
          "uri": "/ondemand/pages/61326/season/12345"
        },
        "texttracks": {
          "total": 2,
          "uri": "/videos/258684937/texttracks"
        },
        "trailer": {
          "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
          "uri": "/ondemand/pages/61326/videos/12345"
        },
        "users_with_access": {
          "total": 8,
          "uri": "/videos/258684937/privacy/users"
        },
        "versions": {
          "current_uri": "/videos/258684937/versions/12345",
          "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
          "total": 3,
          "uri": "/videos/258684937/versions"
        }
      },
      "interactions": {
        "buy": {
          "currency": "USD",
          "display_price": "5.99",
          "download": "available",
          "drm": true,
          "link": "https://vimeo.com/ondemand/darbyforever",
          "price": 5.99,
          "purchase_time": "2018-03-05T21:04:47+00:00",
          "stream": "available",
          "uri": "/ondemand/pages/61326/products/12345"
        },
        "like": {
          "added": true
        },
        "rent": {
          "currency": "USD",
          "display_price": "5.99",
          "drm": true,
          "expires_time": "2018-03-05T21:04:47+00:00",
          "link": "https://vimeo.com/ondemand/darbyforever",
          "price": 5.99,
          "purchase_time": "2018-09-16T09:02:40+00:00",
          "stream": "available",
          "uri": "/ondemand/pages/61326/products/12345"
        },
        "subscribe": {
          "drm": true,
          "expires_time": "2018-03-05T21:04:47+00:00",
          "purchase_time": "2018-03-02T21:04:47+00:00",
          "stream": "purchased"
        },
        "watched": {
          "added": true
        },
        "watchlater": {
          "added": true
        }
      }
    },
    "modified_time": "2018-09-16T09:02:40+00:00",
    "name": "Celebrating 10 Years of Staff Picks",
    "parent_folder": {
      "created_time": "2017-05-23T14:36:22+00:00",
      "metadata": {
        "connections": {
          "videos": {
            "total": 12,
            "uri": "/users/152184/projects/12345/videos"
          }
        }
      },
      "modified_time": "2017-05-23T14:36:22+00:00",
      "name": "Rough cuts",
      "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
      "uri": "/me/projects/12345",
      "user": {
        "account": "basic",
        "bio": "This is where you will find videos and news updates from the staff.",
        "created_time": "2007-01-18T16:40:11+00:00",
        "email": "user@example.com",
        "link": "https://vimeo.com/staff",
        "location": "New York City",
        "metadata": {
          "connections": {
            "albums": {
              "total": 3,
              "uri": "/users/152184/albums"
            },
            "appearances": {
              "total": 6,
              "uri": "/users/152184/appearances"
            },
            "block": {
              "total": 73,
              "uri": "/me/block"
            },
            "categories": {
              "total": 5,
              "uri": "/users/152184/categories"
            },
            "channels": {
              "total": 4,
              "uri": "/users/152184/channels"
            },
            "feed": {
              "uri": "/users/152184/feed"
            },
            "folders": {
              "total": 9,
              "uri": "/me/folders"
            },
            "followers": {
              "total": 12,
              "uri": "/users/152184/followers"
            },
            "following": {
              "total": 47,
              "uri": "/users/152184/following"
            },
            "groups": {
              "total": 2,
              "uri": "/users/152184/groups"
            },
            "likes": {
              "total": 300,
              "uri": "/users/152184/likes"
            },
            "moderated_channels": {
              "total": 1,
              "uri": "/users/152184/channels?filter=moderated"
            },
            "pictures": {
              "total": 3,
              "uri": "/users/152184/pictures"
            },
            "portfolios": {
              "total": 5,
              "uri": "/users/152184/portfolios"
            },
            "recommended_channels": {
              "total": 4,
              "uri": "/me/recommendations/channels"
            },
            "recommended_users": {
              "total": 6,
              "uri": "/me/recommendations/users"
            },
            "shared": {
              "total": 15,
              "uri": "/users/152184/shared/videos"
            },
            "videos": {
              "total": 36,
              "uri": "/users/152184/videos"
            },
            "watched_videos": {
              "total": 322,
              "uri": "/me/watched/videos"
            },
            "watchlater": {
              "total": 14,
              "uri": "/users/152184/watchlater"
            }
          },
          "interactions": {
            "add_privacy_user": {
              "uri": "/channels/152184/privacy/users"
            },
            "block": {
              "added": true,
              "added_time": "2017-05-16T15:05:43+00:00",
              "uri": "/me/block/3766357"
            },
            "follow": {
              "added": true,
              "uri": "/users/152184/following/3766357"
            },
            "report": {
              "uri": "/users/152184/report"
            }
          }
        },
        "name": "Vimeo Staff",
        "pictures": {
          "active": true,
          "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
          "sizes": [
            {
              "height": 720,
              "link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
              "link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
              "width": 1280
            }
          ],
          "type": "caution",
          "uri": "/users/152184/pictures/12345"
        },
        "preferences": {
          "videos": {
            "privacy": {
              "add": true,
              "comments": "anybody",
              "download": true,
              "embed": "private",
              "view": "anybody"
            }
          }
        },
        "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
        "upload_quota": {
          "lifetime": {
            "free": 5000000,
            "max": 5368709120,
            "used": 5368704120
          },
          "periodic": {
            "free": 5000000,
            "max": 5368709120,
            "reset_date": "2029-03-13T02:35:13-04:00",
            "used": 5368704120
          },
          "space": {
            "free": 5000000,
            "max": 5368709120,
            "showing": "lifetime",
            "used": 5368704120
          }
        },
        "uri": "/users/152184",
        "websites": [
          {
            "description": "Follow us on Twitter!",
            "link": "https://twitter.com/vimeo",
            "name": "Twitter"
          }
        ]
      }
    },
    "password": "hunter1",
    "pictures": {
      "active": true,
      "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
      "sizes": [
        {
          "height": 720,
          "link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
          "link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
          "width": 1280
        }
      ],
      "type": "caution",
      "uri": "/users/152184/pictures/12345"
    },
    "privacy": {
      "add": true,
      "comments": "anybody",
      "download": true,
      "embed": "private",
      "view": "anybody"
    },
    "release_time": "2018-03-05T21:04:47+00:00",
    "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
    "spatial": {
      "director_timeline": [
        {
          "pitch": 70,
          "time_code": 300,
          "yaw": 125
        }
      ],
      "field_of_view": 50,
      "projection": "cubical",
      "stereo_format": "left-right"
    },
    "stats": {
      "plays": 20
    },
    "status": "available",
    "tags": [
      {
        "canonical": "awesome",
        "metadata": {
          "connections": {
            "videos": {
              "total": 34371,
              "uri": "/tags/awesome/videos"
            }
          }
        },
        "name": "awesome",
        "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
        "uri": "/videos/258684937/tags/awesome"
      }
    ],
    "transcode": {
      "status": "complete"
    },
    "type": "video",
    "upload": {
      "approach": "post",
      "size": 60000,
      "status": "complete"
    },
    "uri": "/videos/258684937",
    "user": {
      "account": "basic",
      "bio": "This is where you will find videos and news updates from the staff.",
      "created_time": "2007-01-18T16:40:11+00:00",
      "email": "user@example.com",
      "link": "https://vimeo.com/staff",
      "location": "New York City",
      "metadata": {
        "connections": {
          "albums": {
            "total": 3,
            "uri": "/users/152184/albums"
          },
          "appearances": {
            "total": 6,
            "uri": "/users/152184/appearances"
          },
          "block": {
            "total": 73,
            "uri": "/me/block"
          },
          "categories": {
            "total": 5,
            "uri": "/users/152184/categories"
          },
          "channels": {
            "total": 4,
            "uri": "/users/152184/channels"
          },
          "feed": {
            "uri": "/users/152184/feed"
          },
          "folders": {
            "total": 9,
            "uri": "/me/folders"
          },
          "followers": {
            "total": 12,
            "uri": "/users/152184/followers"
          },
          "following": {
            "total": 47,
            "uri": "/users/152184/following"
          },
          "groups": {
            "total": 2,
            "uri": "/users/152184/groups"
          },
          "likes": {
            "total": 300,
            "uri": "/users/152184/likes"
          },
          "moderated_channels": {
            "total": 1,
            "uri": "/users/152184/channels?filter=moderated"
          },
          "pictures": {
            "total": 3,
            "uri": "/users/152184/pictures"
          },
          "portfolios": {
            "total": 5,
            "uri": "/users/152184/portfolios"
          },
          "recommended_channels": {
            "total": 4,
            "uri": "/me/recommendations/channels"
          },
          "recommended_users": {
            "total": 6,
            "uri": "/me/recommendations/users"
          },
          "shared": {
            "total": 15,
            "uri": "/users/152184/shared/videos"
          },
          "videos": {
            "total": 36,
            "uri": "/users/152184/videos"
          },
          "watched_videos": {
            "total": 322,
            "uri": "/me/watched/videos"
          },
          "watchlater": {
            "total": 14,
            "uri": "/users/152184/watchlater"
          }
        },
        "interactions": {
          "add_privacy_user": {
            "uri": "/channels/152184/privacy/users"
          },
          "block": {
            "added": true,
            "added_time": "2017-05-16T15:05:43+00:00",
            "uri": "/me/block/3766357"
          },
          "follow": {
            "added": true,
            "uri": "/users/152184/following/3766357"
          },
          "report": {
            "uri": "/users/152184/report"
          }
        }
      },
      "name": "Vimeo Staff",
      "pictures": {
        "active": true,
        "resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
        "sizes": [
          {
            "height": 720,
            "link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
            "link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
            "width": 1280
          }
        ],
        "type": "caution",
        "uri": "/users/152184/pictures/12345"
      },
      "preferences": {
        "videos": {
          "privacy": {
            "add": true,
            "comments": "anybody",
            "download": true,
            "embed": "private",
            "view": "anybody"
          }
        }
      },
      "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
      "upload_quota": {
        "lifetime": {
          "free": 5000000,
          "max": 5368709120,
          "used": 5368704120
        },
        "periodic": {
          "free": 5000000,
          "max": 5368709120,
          "reset_date": "2029-03-13T02:35:13-04:00",
          "used": 5368704120
        },
        "space": {
          "free": 5000000,
          "max": 5368709120,
          "showing": "lifetime",
          "used": 5368704120
        }
      },
      "uri": "/users/152184",
      "websites": [
        {
          "description": "Follow us on Twitter!",
          "link": "https://twitter.com/vimeo",
          "name": "Twitter"
        }
      ]
    },
    "width": 1920
  }
]

Changes

  • ea882e0224a4Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • d66f7a79837fRevision changes
    • info

      added the required property / to the response with the status