Reference / @open-music-sdk/client-user / getLibraryPlaylistFolder

Function: getLibraryPlaylistFolder()

function getLibraryPlaylistFolder(
   client, 
   id, 
   options?
): Promise<tLibraryPlaylistFoldersResponse>;

Defined in: clients/client-user/src/resources.ts:378

The playlist folder with an id in the listener's library. The root, p.playlistsroot, was answered 404 by its id against the live API on 18 October 2026, unless asked for with an include, such as ["children"]; a folder made in it was answered without one.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library playlist folder's id.

options?

tEndpointOptions<tLibraryPlaylistFoldersResponse, object, object>

What to send beside the playlist folder.

Returns

Promise<tLibraryPlaylistFoldersResponse>

What Apple answered: the playlist folder under data.

Throws

TypeError if client is no client or an argument is not what it should be, before Apple is asked.

Throws

AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues; _tag says which.

Throws

The reason options.signal aborted with, when it does.

Throws

Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.