GET https://api.vidyard.com/dashboard/v1/players/:id
Get a player

Get a player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "id": 1111,
  "uuid": "eQSsPVXinqGoesujP2Vteg",
  "name": "My Player",
  "description": "The besterest videos",
  "play_button": true,
  "autoplay": false,
  "embed_button": true,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "custom_sharing_link": null,
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "playlist_color": "222222",
  "splash_screen_fade": true,
  "mute_onload": false,
  "disable_playlist": false,
  "playlist_always_open": false,
  "audio_player_visuals": "visualization",
  "on_complete": "splash_screen",
  "redirect_url": null,
  "redirect_whole_page": false,
  "sharing_page": true,
  "sharing_page_comments": true,
  "disable_default_events": false,
  "release_date": 0,
  "expiry_date": null,
  "whitelisted_embed_domain": "http://*.example.com",
  "authorized_by": "",
  "hidden_controls": false,
  "up_next": false,
  "disable_legacy": false,
  "chapters_attributes":[{
    "position":0,
    "player_id":50,
    "video_id":63,
    "video_attributes":{
      "name":"Falcon Punch",
      "upload_url":null,
      "description":"A description",
      "sync":true,
      "audio_gain":0,
      "webhook_url":null,
      "tags_attributes":[],
      "hosting_provider":"youtube",
      "id":63,
      "status":null,
      "error_message":null,
      "created_at":1374178204,
      "updated_at":1374178204
    },
    "id":37,
    "created_at":1374178204,
    "updated_at":1374178204
  }],
  "created_at": 1390585689,
  "updated_at": 1390585689,
  "length_in_seconds": 0,
  "show_playback_speed": false,
  "access_setting": "public",
  "show_time": true
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
id
required

Validations:

  • Parameter has to be Integer.