GET https://api.vidyard.com/dashboard/v1/videos/search
Search for videos in the library

Search the videos in your Vidyard library using the same capabilities available in the dashboard library UI. Combine free-text matching (name, description, tags, internal notes) with structured filters (origin, status, minimum duration, owner, trimmed/stitched, audio).

All parameters are optional and are combined with AND logic; calling the endpoint with no parameters returns every video in the library. Results are paginated and include a summary block describing the current page.

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
{
  "name": "Q3 launch",
  "tags": ["sales", "demo"],
  "origin": ["UPLOAD", "DASHBOARD_SCREEN"],
  "minimum_seconds": 30,
  "order_by": "created_at",
  "direction": "desc",
  "page": 1,
  "per_page": 50
}

RESPONSE
200 (OK)
{
  "videos": [
    {
      "id": 2222,
      "uuid": "4epPofk8TYhIanJLgZyIeA",
      "name": "Q3 launch walkthrough",
      "description": "Recorded walkthrough for the Q3 launch",
      "notes": "Internal only",
      "status": "ready",
      "seconds": 114,
      "origin": "dashboard|screen",
      "created_at": 1346961610,
      "updated_at": 1346961610
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 50,
    "count": 1
  }
}

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

Matches videos whose name contains this text (case-insensitive, partial match)

Validations:

  • Must be a String
description
optional

Matches videos whose description contains this text (case-insensitive, partial match)

Validations:

  • Must be a String
internal_notes
optional

Matches videos whose internal notes contain this text (case-insensitive, partial match)

Validations:

  • Must be a String
uuid
optional

Matches a video by exact UUID

Validations:

  • Must be a String
tags
optional

Tags assigned to the video. Each tag is matched exactly; a video must have all supplied tags (case-insensitive).

Validations:

  • Must be an array of any type
origin
optional

Filter by how the video was created. Values must match the VideoOrigin enum (e.g. UPLOAD, DASHBOARD_CAMERA, DASHBOARD_SCREEN, DASHBOARD_SCREENCAMERA, GOVIDEO_CHROME_EXTENSION_SCREEN, DESKTOP_APP_SCREEN, MOBILE_CAMERA, ZOOM). Unknown values are ignored.

Validations:

  • Must be an array of any type
video_status
optional

Filter by video processing status (e.g. uploaded, encoding, ready). Matches any of the supplied statuses.

Validations:

  • Must be an array of any type
minimum_seconds
optional

Only return videos at least this many seconds long

Validations:

  • Parameter has to be Integer.
user_id
optional

Only return videos owned by this user id

Validations:

  • Parameter has to be Integer.
is_trimmed
optional

When true, only trimmed videos; when false, only untrimmed videos

Validations:

  • Parameter has to be Boolean.
is_stitched
optional

When true, only stitched videos; when false, only un-stitched videos

Validations:

  • Parameter has to be Boolean.
exclude_audio_only
optional

When true, exclude audio-only recordings from the results
Default: false

Validations:

  • Parameter has to be Boolean.
include_descendants
optional

When true, also search videos in nested folders you have access to
Default: false

Validations:

  • Parameter has to be Boolean.
order_by
optional

The attribute to order the list by
Default: created_at

Validations:

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

The direction to order the list
Default: desc

Validations:

  • Must be one of: asc, desc.
per_page
optional

The number of items to show per page
Maximum: 200, Default: 50

Validations:

  • Parameter has to be Integer.
page
optional

The page number to include in the response
Default: 1

Validations:

  • Parameter has to be Integer.