Navigate

Kaltura API Documentationplaylist.list

List available playlists

Try it out
post https://www.kaltura.com/api_v3/service/playlist/action/list

Request Parameters

body:object
SchemaExample
object
filter:object:KalturaPlaylistFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], END_DATE_ASC [+endDate], MODERATION_COUNT_ASC [+moderationCount], NAME_ASC [+name], PARTNER_SORT_VALUE_ASC [+partnerSortValue], RANK_ASC [+rank], RECENT_ASC [+recent], START_DATE_ASC [+startDate], TOTAL_RANK_ASC [+totalRank], UPDATED_AT_ASC [+updatedAt], WEIGHT_ASC [+weight], CREATED_AT_DESC [-createdAt], END_DATE_DESC [-endDate], MODERATION_COUNT_DESC [-moderationCount], NAME_DESC [-name], PARTNER_SORT_VALUE_DESC [-partnerSortValue], RANK_DESC [-rank], RECENT_DESC [-recent], START_DATE_DESC [-startDate], TOTAL_RANK_DESC [-totalRank], UPDATED_AT_DESC [-updatedAt], WEIGHT_DESC [-weight]
playListTypeEqual:integer
Enum: STATIC_LIST [3], DYNAMIC [10], EXTERNAL [101], PATH [102]
Enum Type: KalturaPlaylistType


playListTypeIn:string
KalturaPlaylistFilter must also match all of:
object:KalturaPlaylistBaseFilter
pager:object:KalturaFilterPager
The KalturaFilterPager object enables paging management to be applied upon service list actions.


KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

SchemaExample
object:KalturaPlaylistListResponse
objects:array[object:KalturaPlaylist]
object:KalturaPlaylist
duration:integer
readOnly


The duration in seconds


executeUrl:string
readOnly


The url for this playlist


filters:array[object:KalturaMediaEntryFilterForPlaylist]playlistContent:string
Content of the playlist - 


XML if the playlistType is dynamic 


text if the playlistType is static 


url if the playlistType is mRss


playlistType:integer
Enum: STATIC_LIST [3], DYNAMIC [10], EXTERNAL [101], PATH [102]
insertOnly


Enum Type: KalturaPlaylistType


Type of playlist


plays:integer
readOnly


Number of plays


totalResults:integer
Maximum count of results to be returned in playlist execution


views:integer
readOnly


Number of views


KalturaPlaylist must also match all of:
object:KalturaBaseEntry
KalturaPlaylistListResponse must also match all of:
object:KalturaListResponse