Logo

Docs

Playlists

Playlist Models

The playlist resource types used across the OpenMusic API.

BasePlaylist

Minimal playlist resource shape used for view=minimal and nested relationships.

interface BasePlaylist extends ResourceBase {
  type: "playlists";
  relationships?: {
    tracks?: (Song | BaseSong)[];
  };
}

Playlist

Full playlist resource returned when attributes are requested; extends BasePlaylist.

interface Playlist extends BasePlaylist {
  attributes: PlaylistAttributes;
}

PlaylistAttributes

Full metadata fields attached to Playlist.

interface PlaylistAttributes {
  name: string;
  curator_name: string;
  description: string | null;
  artwork_url: string | null;
  genres: string[];
}

On this page