Get a playlist by ID | FastPix Developer Documentation

{
  "success": true,
  "data": {
    "id": "46d5fce1-683a-457f-86d7-c048bb429505",
    "name": "My Playlist",
    "referenceId": "122q",
    "type": "smart",
    "description": "This Playlist contains videos from December 2024.",
    "playOrder": "createdDate DESC",
    "metadata": {
      "createdData": {
        "endDate": "2024-12-12T00:00:00.000Z",
        "startDate": "2024-12-11T00:00:00.000Z"
      },
      "updatedData": {
        "endDate": "2024-12-12T00:00:00.000Z",
        "startDate": "2024-12-11T00:00:00.000Z"
      }
    },
    "mediaList": [
      {
        "createdAt": "2025-05-27T09:37:52.445936Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "a1cd180e-f9b5-4e99-9d44-b9c9baabad89",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://venus-images.fastpix.dev/bed25609-1887-4c49-91a5-5c6b1edeb1a2/thumbnail.png",
        "title": "Media 1"
      },
      {
        "createdAt": "2025-04-04T13:26:23.507284Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "245800c3-7b73-47d9-a201-e961260dcb30",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://mercury-images.fastpix.dev/3c6ceeea-d24b-487f-9dd0-5a16148b5d46/thumbnail.png",
        "title": "Media 2"
      },
      {
        "createdAt": "2025-04-04T13:26:12.552840Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "41316aac-5396-4278-8f44-08d5f2495b12",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://mercury-images.fastpix.dev/8989d0d3-5c5b-41b2-89d5-df6094e6093f/thumbnail.png",
        "title": "Media 3"
      }
    ],
    "workspaceId": "d760b903-86ef-44d6-9b73-334130e0cf2d",
    "createdAt": "2025-06-05T09:10:30.655275Z",
    "updatedAt": "2025-06-05T12:23:47.096690Z",
    "mediaCount": 3
  }
}

This endpoint retrieves detailed information about a specific playlist using its unique playlistId. It provides comprehensive metadata about the playlist, including its title, creation mode (manual or smart), media items along with the metadata of each media in the playlist.

Example

An e-learning platform requests details for the playlist “Beginner Python Series” by providing its unique playlistId. The response includes the playlist”s title, creation mode, and the ordered list of video tutorials contained within, enabling the platform to present the full learning path to users.

This endpoint retrieves detailed information about a specific playlist using its unique `playlistId`. It provides comprehensive metadata about the playlist, including its title, creation mode (manual or smart), media items along with the metadata of each media in the playlist. #### Example An e-learning platform requests details for the playlist "Beginner Python Series" by providing its unique `playlistId`. The response includes the playlist"s title, creation mode, and the ordered list of video tutorials contained within, enabling the platform to present the full learning path to users.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

playlistIdstringRequired

The unique id of the playlist you want to retrieve.

Response

Successfully retrieved all playlists

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

$	curl https://api.fastpix.com/v1/on-demand/playlists/playlistId \
>	-u "<username>:<password>"