VIvimeo
Categories\Essentials

Get all categories

This method gets all existing categories.

get/categories

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.

sort'last_video_featured_time' | 'name'

The way to sort the results.

Response

The categories were returned.

last_video_featured_timestring required

The last time, in ISO 8601 format, that a video was featured.

linkstring required

The URL to access the category in a browser.

namestring required

The display name that identifies the category.

resource_keystring required

The resource key of the category.

top_levelboolean required

Whether the category isn't a subcategory of another category.

uristring required

The unique identifier to access the category resource.

Example response

[
  {
    "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"
  }
]

Changes

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