Get a list of videos

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
{
  "videos": [
    {
      "id": 2222,
      "uuid": "4epPofk8TYhIanJLgZyIeA",
      "name": "My Video",
      "upload_url": "http://myvideos.com/video.mp4",
      "description": "People hard at work, or hardly working?",
      "notes": "This video shows our old logo we should replace it soon...",
      "audio_gain": 20,
      "webhook_url": "http://callbacktest.herokuapp.com/",
      "sync": true,
      "status": "uploaded",
      "error_message": null,
      "created_at": 1346961610,
      "updated_at": 1346961610
    },
    {
      "id": 2245,
      "uuid": "2v2Ny2VYYH2HI_5ytJYpAA",
      "name": "My Other Video",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 100
  }
}

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

order_by
optional

The attribute to order the list by
Value: Must be one of: name, views, created_at, updated_at

Validations:

  • Must be a String

direction
optional

When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be a String

query
optional

String used to search for a set of videos by player / video name as well as associated tags

Validations:

  • Must be a String

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.