VIvimeo
Channels\Essentials

Get a specific channel

This method gets a single channel.

get/channels/{channel_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

channel_idnumber required
Example:927

The ID of the channel.

Response

The channel was returned.

created_timestring required

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

descriptionstring nullable required

A brief explanation of the channel's content.

linkstring required

The URL to access the channel in a browser.

modified_timestring required

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

namestring required

The display name that identifies the channel.

resource_keystring required

The channel resource key.

uristring required

The unique identifier to access the channel resource.

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"
    }
  ],
  "created_time": "2007-10-23T17:00:43+00:00",
  "description": "We really love videos, and these are the videos we really, really love.",
  "header": {
    "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"
  },
  "link": "https://vimeo.com/channels/staffpicks",
  "metadata": {
    "connections": {
      "privacy_users": {
        "total": 36,
        "uri": "/channels/927/privacy/users"
      },
      "users": {
        "total": 794634,
        "uri": "/channels/927/users"
      },
      "videos": {
        "total": 12448,
        "uri": "/channels/927/videos"
      }
    },
    "interactions": {
      "add_moderators": {
        "uri": "/channels/1234/moderators"
      },
      "add_to": {
        "uri": "/channels/1234/videos/5678"
      },
      "follow": {
        "added": true,
        "added_time": "2017-05-22T17:50:11+00:00",
        "type": "moderator",
        "uri": "/users/1234/channels/927"
      },
      "moderate_videos": {
        "uri": "/channels/1234/videos"
      }
    }
  },
  "modified_time": "2018-03-21T22:52:29+00:00",
  "name": "Vimeo Staff Picks",
  "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": {
    "view": "anybody"
  },
  "resource_key": "e5595241643259c658ed6c85ca82985a6341edc7",
  "tags": [
    {
      "canonical": "awesome",
      "metadata": {
        "connections": {
          "videos": {
            "total": 34371,
            "uri": "/tags/awesome/videos"
          }
        }
      },
      "name": "awesome",
      "resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
      "uri": "/videos/258684937/tags/awesome"
    }
  ],
  "uri": "/channels/927",
  "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"
      }
    ]
  }
}

Changes

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