VIvimeo
Users\Essentials

Get a user

This method returns the representation of the authenticated user.

get/me

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.

Response

The user's representation was returned.

account'basic' | 'business' | 'live_business' | 'live_premium' | 'live_pro' | 'plus' | 'pro' | 'pro_unlimited' | 'producer' required

The user's account type:

Option descriptions:

  • basic - The user has a Vimeo Basic subscription.
  • business - The user has a Vimeo Business subscription.
  • live_business - The user has a Vimeo Business Live subscription.
  • live_premium - The user has a Vimeo Premium subscription.
  • live_pro - The user has a Vimeo PRO Live subscription.
  • plus - The user has a Vimeo Plus subscription.
  • pro - The user has a Vimeo Pro subscription.
  • pro_unlimited - The user has a Vimeo PRO Unlimited subscription.
  • producer - The user has a Vimeo Producer subscription.
biostring nullable required

The user's bio.

content_filterstring[]

The user's content filters:

Option descriptions:

  • drugs - Drugs or alcohol use.
  • language - Profanity or sexually suggestive content.
  • nudity - Nudity.
  • safe - Suitable for all audiences.
  • unrated - No rating.
  • violence - Violent or graphic content.
created_timestring required

The time in ISO 8601 format when the user account was created.

emailstring

The user's email address. This data requires a bearer token with the email scope.

linkstring required

The absolute URL of this user's profile page.

locationstring nullable required

The user's location.

namestring required

The user's display name.

resource_keystring required

The user's resource key string.

uristring required

The user's canonical relative URI.

Example response

{
  "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.