VIvimeo
Embed Presets\Custom logos

Get a specific custom logo

Changed on

This method returns a single custom logo belonging to the specified user.

get/users/{user_id}/customlogos/{logo_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

logo_idnumber required
Example:12345

The ID of the custom logo.

user_idnumber required
Example:152184

The ID of the user.

Response

The custom logo was returned.

activeboolean required

Whether this picture is the active picture for its parent resource.

linkstring

The upload URL for the picture. This field appears when you create the picture resource for the first time.

resource_keystring required

The picture's resource key string.

type'caution' | 'custom' | 'default' required

The type of the picture:

Option descriptions:

  • caution - An image that is appropriate for all ages.
  • custom - A custom image for the video.
  • default - The default image for the video.
uristring required

The picture's URI.

Example response

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

Changes