For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • ACTIVATE ACCOUNT
    • Create account
  • PRODUCT OS API
    • Overview
  • ERROR CODES
    • Error codes
  • VIDEO ON DEMAND API
    • Overview
      • GETGet all playlists
      • POSTCreate a new playlist
      • GETGet a playlist by ID
      • PUTUpdate a playlist by ID
      • DELDelete a playlist by ID
      • PUTChange media order in a playlist by ID
      • DELDelete media in a playlist by ID
      • PATCHAdd media to a playlist by ID
  • LIVE STREAM API
    • Overview
  • VIDEO DATA API
    • Overview
LogoLogo
StatusSupportDiscussionsLog inSign Up
VIDEO ON DEMAND APIPlaylist

Get all playlists

GET
https://api.fastpix.com/v1/on-demand/playlists
GET
/v1/on-demand/playlists
$curl https://api.fastpix.com/v1/on-demand/playlists \
>     -u "<username>:<password>"
200Retrieved
1{
2  "success": true,
3  "data": [
4    {
5      "id": "db6e860f-cb57-43dd-8acf-39c9effd5608",
6      "name": "playist1",
7      "type": "smart",
8      "referenceId": "playlists101",
9      "createdAt": "2025-06-04T13:29:04.253244Z",
10      "mediaCount": 0
11    },
12    {
13      "id": "5c18559f-c1b1-4697-9282-77211d4396bb",
14      "name": "playist2",
15      "type": "smart",
16      "referenceId": "playlists102",
17      "createdAt": "2025-06-04T13:01:05.073809Z",
18      "mediaCount": 0
19    },
20    {
21      "id": "a4735902-b5e6-431f-8875-7a1a2cbc7a7b",
22      "name": "Onboarding",
23      "type": "manual",
24      "referenceId": "playlists103",
25      "createdAt": "2025-06-04T12:17:38.917664Z",
26      "mediaCount": 0
27    },
28    {
29      "id": "1ffce718-7072-4b61-9b27-e7d18198094d",
30      "name": "December playlist",
31      "type": "manual",
32      "referenceId": "playlists104",
33      "createdAt": "2025-05-15T11:06:51.545280Z",
34      "mediaCount": 0
35    },
36    {
37      "id": "2455174e-64d9-4324-86bd-80cb1af5b20a",
38      "name": "March Highlights",
39      "type": "smart",
40      "referenceId": "playlists105",
41      "createdAt": "2025-05-12T12:55:24.368182Z",
42      "mediaCount": 9
43    },
44    {
45      "id": "d55c4e51-e426-498f-b760-6f9357e2349e",
46      "name": "playlist1",
47      "type": "smart",
48      "referenceId": "playlists106",
49      "createdAt": "2025-05-07T10:49:29.226943Z",
50      "mediaCount": 9
51    },
52    {
53      "id": "63d73b6e-50dd-4653-990b-8a8df85ad09f",
54      "name": "playlist1",
55      "type": "smart",
56      "referenceId": "playlists107",
57      "createdAt": "2025-05-07T10:48:09.179324Z",
58      "mediaCount": 9
59    },
60    {
61      "id": "5a93de86-0848-4ab4-befe-8dba4b8433e5",
62      "name": "playlist1",
63      "type": "smart",
64      "referenceId": "playlists108",
65      "createdAt": "2025-05-07T10:47:06.339271Z",
66      "mediaCount": 9
67    },
68    {
69      "id": "d315b847-38c4-431f-b1b6-32dc5013700a",
70      "name": "playlist1",
71      "type": "smart",
72      "referenceId": "playlists109",
73      "createdAt": "2025-05-07T10:03:21.487649Z",
74      "mediaCount": 9
75    },
76    {
77      "id": "86348042-6367-4dfc-b018-b3ee9934f45b",
78      "name": "playlist1",
79      "type": "manual",
80      "referenceId": "playlists201",
81      "createdAt": "2025-05-05T12:48:44.177451Z",
82      "mediaCount": 2
83    }
84  ],
85  "pagination": {
86    "totalRecords": 46,
87    "currentOffset": 1,
88    "offsetCount": 5
89  }
90}
This endpoint retrieves all playlists in a specified workspace. It allows you to view the collection of manual and smart playlists along with their associated metadata. #### How it works - When a user sends a GET request to this endpoint, FastPix returns a list of all playlists in the workspace, including details such as playlist IDs, titles, creation mode (manual or smart), and other relevant metadata. #### Example An e-learning platform requests all playlists within a workspace to display an overview of available learning paths. The response includes multiple playlists like "Beginner Python Series" and "Advanced Java Tutorials," enabling the platform to show users a catalog of curated content collections.
Was this page helpful?
Previous

Create a new playlist

Next
Built with

This endpoint retrieves all playlists in a specified workspace. It allows you to view the collection of manual and smart playlists along with their associated metadata.

How it works

  • When a user sends a GET request to this endpoint, FastPix returns a list of all playlists in the workspace, including details such as playlist IDs, titles, creation mode (manual or smart), and other relevant metadata.

Example

An e-learning platform requests all playlists within a workspace to display an overview of available learning paths. The response includes multiple playlists like “Beginner Python Series” and “Advanced Java Tutorials,” enabling the platform to show users a catalog of curated content collections.

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

Query parameters

limitintegerOptional1-50Defaults to 10

The number of playlists to return (default is 10, max is 50).

offsetintegerOptional>=1Defaults to 1
The page number to retrieve, starting from 1. Use this parameter to paginate the playlist results.

Response

Successfully retrieved all playlists
successboolean
Shows the request status. Returns true for success and false for failure.
datalist of objects
paginationobject
Pagination organizes content into pages for better readability and navigation.