VIvimeo
Portfolios\Essentials

Get a specific portfolio

This method gets a single portfolio from the specified user.

get/users/{user_id}/portfolios/{portfolio_id}

Request

  • Base URL
    https://api.vimeo.com
  • Auth
    OAuth 2
    Authorization code/oauth/authorize, token URL /oauth/access_token
    Client credentialsToken URL /oauth/authorize/client
    Scopescreate, delete, edit, email, interact, private, promo_codes, public, purchase, purchased, stats, upload, video_files
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

portfolio_idnumber required
Example:12345

The ID of the portfolio.

user_idnumber required
Example:152184

The ID of the user.

Response

The portfolio was returned.

created_timestring required

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

descriptionstring nullable required

The portfolio's description.

linkstring required

The link to the portfolio.

modified_timestring required

The time in ISO 8601 format when the portfolio's data was last modified.

namestring required

The display name of the portfolio.

sort'alphabetical' | 'clips' | 'modified' | 'recent' required

The default video sort order for the portfolio:

Option descriptions:

  • alphabetical - The default sort order is alphabetical by name.
  • clips - The default sort order is video creation date.
  • modified - The default sort order is the order in which the videos were modified.
  • recent - The default sort order is the order in which the videos were added.
uristring required

The canonical relative URI of the portfolio.

Example response

{
  "created_time": "2017-05-16T19:56:07+00:00",
  "description": "The Vimeo Staff original productions.",
  "link": "https://vimeopro.com/staff/originals",
  "metadata": {
    "connections": {
      "videos": {
        "total": 18,
        "uri": "/users/152184/portfolios/12345/videos"
      }
    }
  },
  "modified_time": "2017-05-17T19:56:07+00:00",
  "name": "Vimeo Originals!",
  "sort": "alphabetical",
  "uri": "/users/152184/portfolios/12345"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.