Search for players based on player properties

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
Content-Type: application/json
{
  "mute_onload": false,
  "pause_disabled": true,
  "default_hd": false,
  "height": 360,
  "width": 400,
  "splash_screen_fade": true,
  "color": "#ffffff",
  "sharing_page_comments": true,
  "play_button": true,
  "hd_button": true,
  "sharing_page": true,
  "embed_button": true,
  "playlist_color": "#ffffff",
  "autoplay": false,
  "viral_sharing": false,
  "viral_sharing_message": "Check out this cool video!",
  "custom_sharing_link": "www.vidyard.com",
  "authorized_by": null,
  "hidden_controls": false,
  "up_next": false,
  "custom_attribute_name": "internal_name",
  "custom_attribute_value": "new internal product launch"
}

RESPONSE
200 (OK)
[
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
]

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

name
optional

Filters players based on specified player name (exact match only)

Validations:

  • Must be a String

mute_onload
optional

Filters players based on specified mute_onload value

Validations:

  • Parameter has to be Boolean.

pause_disabled
optional

Filters players based on specified pause_disabled value

Validations:

  • Parameter has to be Boolean.

default_hd
optional

Filters players based on specified default_hd value

Validations:

  • Parameter has to be Boolean.

height
optional

Filters players based on specified height value

Validations:

  • Parameter has to be Integer.

width
optional

Filters players based on specified width value

Validations:

  • Parameter has to be Integer.

splash_screen_fade
optional

Filters players based on specified splash_screen_fade value

Validations:

  • Parameter has to be Boolean.

color
optional

Filters players based on player colour value

Validations:

  • Must be a String

play_button_color
optional

Filters players based on play button colour value

Validations:

  • Must be a String

sharing_page_comments
optional

Filters players based on specified sharing_page_comments value

Validations:

  • Parameter has to be Boolean.

play_button
optional

Filters players based on specified play_button value

Validations:

  • Parameter has to be Boolean.

hd_button
optional

Filters players based on specified hd_button

Validations:

  • Parameter has to be Boolean.

sharing_page
optional

Filters players based on specified sharing_page value

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Filters players based on specified embed_button value

Validations:

  • Parameter has to be Boolean.

playlist_color
optional

Filters players based on specified playlist_color value

Validations:

  • Must be a String

autoplay
optional

Filters players based on specified autoplay value

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Filters players based on specified viral_sharing value

Validations:

  • Parameter has to be Boolean.

viral_sharing_message
optional

Filters players based on specified viral_sharing_message value

Validations:

  • Must be a String

custom_sharing_link
optional

Filters players based on specified custom_sharing_link value

Validations:

  • Must be a String

chatter_only
optional

Filters players based on specified chatter_only value

Validations:

  • Parameter has to be Boolean.

hidden_controls
optional

Filters players based on specific hidden_controls value

Validations:

  • Parameter has to be Boolean.

up_next
optional

Filters players based on Up Next feature

Validations:

  • Parameter has to be Boolean.

disable_live_dvr
optional

Filters players based on whether live stream DVR is disabled

Validations:

  • Parameter has to be Boolean.

disable_legacy
optional

Filters players based on allowance of legacy mode

Validations:

  • Parameter has to be Boolean.

custom_attribute_name
optional

Filters players based on specific custom attribute, must be used in conjunction with custom_attribute_value

Validations:

  • Must be a String

custom_attribute_value
optional

Filters players based on specific custom attribute value, must be used in conjunction with custom_attribute_name

Validations:

  • Must be a String

order_by
optional

Set the property to order the results of the search

Validations:

  • Must be one of: name, created_at, updated_at.

direction
optional

Direction of the sorting of results

Validations:

  • Must be one of: asc, desc.

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.