Skip to main content

GET All Links for a Playlist


The following table contains important information about the GET method in regards to receiving all links for a playlist.

GET All Links for a Playlist
URL or Endpoint/playlist/embed/playerPublicId/playlistPublicId
ParametersplayerPublicId, playlistPublicId
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
playerPublicIdYesstringUnique Id of the player.
playlistPublicIdYesstringUnique id of the playlist.

Request Body

The request does not contain a request body


"success": true,
"errors": [],
"messages": [],
"result": {
"javaScriptEmbedCode": " <script src=''></script>",
"iFrameEmbedCode": " <div style='position:relative; overflow:hidden; padding-bottom:56.25%'> <iframe src='' width='100%' height='100%' frameborder='0' scrolling='auto' title='untitled playlist 6666666' style='position:absolute;' allowfullscreen> </iframe> </div>"
"resultInfo": null,
"statusCode": 200

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.
javaScriptEmbedCodestringThe embed code of the javascript script.
iFrameEmbedCodestringThe embed code of the iFrame.
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.


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