VIvimeo
Portfolios\Essentials

Get all the portfolios that belong to a user

This method gets all the specified user's portfolios.

get/me/portfolios

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.

Query parameters

direction'asc' | 'desc'
Example:asc

The sort direction of the results.

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.

querystring
Example:Stop motion

The search query to use to filter the results.

sort'alphabetical' | 'date'

The way to sort the results.

Response

The portfolios were 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.