REreveldigital
Playlists

Gets all playlists in an account.

Changed on
get/playlists

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring

Optional playlist Id to filter by

takeinteger

Optional number of items to return

pageinteger

Optional number of page to return

group_idstring[]
group_namestring[]

Response

Returns an array of playlists

idstring nullable

The playlist id

namestring nullable

The playlist name

group_namestring nullable

The group name

group_idstring nullable

The group id

tagsstring nullable

The tags associated with this playlist

type'Multimedia' | 'Slideshow' | 'Template' | 'Marquee'
durationinteger nullable

User-defined fixed duration for this playlist in seconds. Used in conjunction with loop policy to control how sources are looped or truncated to fit within this fixed duration. This is different from CalculatedDuration which represents the sum of all source durations.

calculated_durationinteger nullable

The total calculated duration of the playlist in seconds, based on the sum of all source intervals. This is a read-only property computed from individual source durations and cannot be updated via PUT/POST.

is_random_startboolean nullable

Randomize the order of the playlist

created_onstring date-time nullable

The date the playlist was created

created_by_idstring nullable

The user id that created the playlist

modified_onstring date-time nullable

The date the playlist was last modified

modified_by_idstring nullable

The user id that last modified the playlist

Changes

  • 0c4ba3fb6d1aRevision changes
    • warning

      added the new AdBreak enum value to the /// response property for the response status