Returns an array of playlists
This call returns all the playlists to which you have access in your workspace. As an administrator, you have access to playlists created by every user, even if the playlist’s sharing option is turned off.
The response to this call contains playlists of all types: static and dynamic playlists made to share in Spotlights and Presentations and all the playlists that are automatically generated each time you create a Review Link.
To determine how many playlists are returned and the order in which they are returned, you can use parameters like pageSize and sortBy. For example, the request below will return the ten most recently created playlists:
https://api.shift.io/v3/playlists?_page=1&_pageSize=10&_sortBy=created&_sort=desc
You can also filter the response using the ownerId path parameter to show playlists created by a specific user:
https://api.shift.io/v3/playlists?ownerId=11111111-2222-3333-4444-555555555555
To see playlists that are shared across your workspace or those that are not shared, use the shareWithAccount parameter:
https://api.shift.io/v3/playlists?shareWithAccount=false
A 200 code is returned when one or more playlists are found. Here is an overview of the properties returned for each playlist:
| id | The playlist’s unique 32-character id |
| name | The playlist’s name |
| description | The playlist’s description. A description is optional when creating a playlist. |
| assetFilter | The sort order for project-based playlists and folder-based playlists. By default, these playlists are sorted by date created in descending order.
This value is null for static playlists. Assets in a static playlist can be arranged in any custom order. By default, the assets appear in the order in which they were added to the playlist. |
| type | A static playlist is type STATIC. A static playlist that contains folders or a mix of folders and files is type COLLECTION. A static playlist that is empty is type NONE.
A dynamic project-based playlist is type PROJECT. A dynamic folder-based playlist is type FOLDER. See the information box below to learn more about dynamic playlists. |
| created | The Unix timestamp of the date and time the playlist was created |
| modified | The Unix timestamp of the date and time the playlist was last edited |
| owner | This object contains the name and user id of the user who created the playlist. It also includes an AWS link to the user’s avatar/profile picture (if the user uploaded one) and any information the user has provided on their Profile page, including their title, company, website, and location. |
| shareWithAccount | When this boolean is true, the playlist is shared with the entire workspace. When it is false, the playlist is private, and it can only be accessed by the playlist creator or by a workspace administrator. |
| assetIds | The ids of the assets contained in a static playlist.
If the playlist is a folder or project-based playlist, then the id of each asset in the folder or project is not listed here. For this information, see Get assets or Get assets in project. |
| folderId | For folder-based playlists, this is the id of the folder. |
| projectId | For project-based playlists, this is the id of the project.
For folder-based playlists, this is the id of the project that contains the folder. |
| folderIds | The ids of any folders contained in a static playlist, whose playlist type is COLLECTION. This value is null for static playlists that contain assets but no folders. |
| canDownload | When this boolean is true, downloading is enabled on the playlist.
Viewers can download files from a Spotlight or Presentation if downloading is enabled on both the playlist and the media gallery that contains the playlist. |
| sourceName | For project-based playlists, this is the name of the corresponding project. For folder-based playlists, this is the name of the corresponding folder.
The value is null for static playlists. |
| sharing | A playlist is automatically generated each time you create a Review Link. The playlist’s sharing value is “internal” for a Review Link that is shared internally with workspace users only. Playlists created for Spotlights, Presentations, and public Review Links have a sharing value of “external.” |
| visible | This boolean is true for any playlist that is displayed in the Playlist tab in MediaSilo. This includes any static or dynamic playlists to which you have access.
The boolean is false for any “ad hoc” playlists. An ad hoc playlist is created whenever you share assets or folders as a presentation. Those assets or folders are automatically grouped into a playlist that is hidden from the MediaSilo UI. The boolean is also false for any playlist that is automatically generated whenever you create a Review Link. This type of playlist does not appear in the Playlist tab in MediaSilo. |
In MediaSilo, you can turn an entire project or folder into a playlist. This “dynamic” playlist is automatically updated whenever a file is added or removed from the corresponding project or folder.