Skip to main content

GET Playlist by PublicId

Overview


The following table contains important information about the GET method in regards to receiving the playlist by using the public ID.

GET Playlist by PublicId
MethodGET
URL or Endpoint/api/projects/projectId/playlists/id
HeadersAuthorization
Parametersid, projectId, api-version
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
idYesstringUnique Id of the playlist.
projectIdYesstringUnique Id of the project.

Request Body

The request does not contain a request body

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
{
"publicId": "string",
"title": "string",
"description": "string",
"playListPagePermalink": "string",
"playListTypeId": 0,
"playlistDisplayTypeId": 0,
"playlistSortOptionId": 0,
"includeTags": [
"string"
],
"excludeTags": [
"string"
],
"includeTagsState": true,
"excludeTagsState": true,
"folders": [
0
],
"excludeFlags": [
0
],
"includeFlags": [
0
],
"includeAllProjects": true,
"includeProjects": [
"string"
],
"excludeFlagsState": true,
"includeFlagsState": true,
"includeTagModeId": 0,
"excludeTagModeId": 0,
"includeFlagModeId": 0,
"excludeFlagModeId": 0,
"maxVideos": 0,
"dateFrom": "2025-09-25T08:58:34.906Z",
"dateTo": "2025-09-25T08:58:34.906Z",
"canEmbed": true,
"playlistBackupState": true,
"playlistBackupId": "string",
"excludeWatchedVideosState": true,
"excludeKeywords": [
"string"
],
"aspectRatios": [
0
],
"includeTagMode": {
"id": 0,
"name": "string"
},
"excludeTagMode": {
"id": 0,
"name": "string"
},
"playlistType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string"
},
"playlistSortOption": {
"id": 0,
"name": "string"
},
"playlistDisplayType": {
"id": "string",
"name": "string",
"value": "string"
}
}
},
"resultInfo": "string",
"statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
publicIdstringThe id of the playlist.
titlestringThe title of the playlist.
descriptionstringReturns information about the playlist.
playListPagePermalinkinteger($int32)The permalink of the playlist page.
playListTypeIdinteger($int32)The id of the playlist type.
playlistDisplayTypeIdinteger($int32)The id of the playlist display type.
playlistSortOptionIdinteger($int32)The id of the playlist sorting option.
includeTagsarray[string]An array that contains the tags you want to include in the playlist.
excludeTagsarray[string]An array that contains the tags you want to exclude in the playlist.
includeTagsStateboolIndicates whether the tags state is included.
excludeTagsStateboolIndicates whether the tags state is excluded.
foldersarray[integer($int32)]An array of folders whose videos should be included in the playlist.
excludeFlagsarray[integer($int32)]An array that contains the flags you want to exclude in the playlist.
includeFlagsarray[integer($int32)]An array that contains the flags you want to include in the playlist.
includeAllProjectsboolIndicates whether videos from all projects of organization should be included.
includeProjectsarray[string]An array of project Ids whose videos should be included in the playlist.
includeFlagsStateboolIndicates whether the flags state is included.
excludeFlagsStateboolIndicates whether the flags state is excluded.
includeTagModeIdinteger($int32)The id of the includeTag mode.
excludeTagModeIdinteger($int32)The id of the excludeTag mode.
includeFlagModeIdinteger($int32)The id of the includeFlag mode.
excludeFlagModeIdinteger($int32)The id of the excludeFlag mode.
maxVideosinteger($int32)The number of maximum videos in the playlist.
dateTimeFromstring (ISO 8601 datetime)Include videos uploaded on or after this datetime.
dateTimeTostring (ISO 8601 datetime)Include videos uploaded on or before this datetime.
canEmbedboolA boolean that indicates whether the playlist can be embedded or not.
playlistBackupStateboolA boolean that indicates whether the playlist has a backup playlist or not.
playlistBackupIdinteger($int32)The unique identifier of the backup playlist.
excludeWatchedVideosStateboolA boolean that indicates whether the videos previously watched by the user should be included in the playlist or not.
excludeKeywordsarray[string]An array of keywords; videos containing any of these keywords will be excluded from the playlist.
aspectRatiosarray[integer($int32)]An array of aspect ratios; only videos that match the specified aspect ratios will be included in the playlist.
includeTagModearray[Object]Returns the includeTag mode as an array of objects.
idstringThe Id of the tag mode.
namestringThe name of the tag mode.
excludeTagModearray[Object]Returns the excludeTag mode as an array of objects.
idinteger($int32)The Id of the tag mode.
namestringThe name of the tag mode.
playlistTypearray[Object]Returns the playlist type as an array of objects.
idinteger($int32)The Id of the playlist type.
namestringThe name of the playlist type.
valuestringThe value of the playlist type.
descriptionstringThe description of the playlist type.
playlistSortOptionarray[Object]Returns the palylist sort option as ana array of objects.
idinteger($int32)The Id of the playlist sort option.
namestringThe name of the playlist sort option.
playlistDisplayTypearray[Object]Returns the playlist display type as an array of objects.
idinteger($int32)The Id of the playlist display type.
namestringThe name of the playlist display type.
valuestringThe value of the playlist display type.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed