Skip to content
Media Manager Docs

Get a paginated list of all published media content

GET
/media

List all media content with available filtering

Authorizations

Parameters

Query Parameters

team_id
required
integer

The team id to use for the request

Example
1
filter[token]
string

Filter media for a specific token or tokens as a comma list

Example
fa9ef782-4e41-428f-8add-8440878790ec,956916a0-443d-474a-a421-5240fdc91fc5
filter[folder_id]
string

Filter by folder id or comma list of ids

Example
2,4
filter[video]
string

Filter media for video only

Example
true
filter[audio]
string

Filter media for audio only

Example
true
filter[live]
string

Filter media for livestreams only

Example
true
filter[title]
string

Filter media by words in the title as single word or comma list

Example
fund,asset range
filter[description]
string

Filter media by words in the description as single word or comma list

Example
zero target,allocation approach
filter[custom_fields]

Filter media by custom fields.

You can filter with filter[custom_fields]=hedge to return any media which has a custom field containing the filter term. Or you can filter on specific fields by adding an extra filter for that field, filter[custom_fields][drupal_uid]=11

Filtering on custom fields does support comma lists, but only on the custom_fields filter. Such as filter[custom_fields]=11,303

One of:
string
hedge,fund
Example
funds,asset
sort
string

Sort returned media by allowed fields.

  • title
  • created_at
  • updated_at

By default sorting is ascending, for descending order prefix with a hyphen.

  • sort=title A -> Z
  • sort=-title Z -> A
  • sort=created_at Oldest first
  • sort=-created_at Newest first
page
integer

Which page to return results for

Example
4
key
string

Internal use

Responses

200

OK

object
data
Array<object>

Shared schema for all media of any content type

object
token
string format: uuid
type
string
Allowed values: Audio Video
title
string
tags
Array<string>
duration
number
version
integer
is_downloadable
boolean
nullable
is_live
boolean
created_at
string format: date-time
updated_at
string format: date-time
sub_property_id
integer
custom_fields

Custom fields as key value pairs

object
key
additional properties
string
player
object
color
string
button
object
title
string
url
string format: uri
media
object
playlist
string
aspect_ration
string
nullable
thumbnail
string format: uri
nullable
transcript
string format: uri
nullable
tracks
object
chapters
string format: uri
captions
Array<string>
storyboard
string format: uri
key
additional properties
any
links
object
first
string
last
string
prev
string
nullable
next
string
nullable
meta
object
current_page
integer
from
integer
nullable
last_page
integer
links
Array<object>
object
url
string
nullable
label
string
active
boolean
path
string
per_page
integer
to
integer
nullable
total
integer

400

Bad request

object
message
string

401

Missing or invalid Authorization Bearer token

object
message
string

404

Item is missing or not found

object
error
string
default: Not found