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

Function: getRootLibraryPlaylistFolder()

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

Defined in: clients/client-user/src/library.ts:215

The folder every playlist and playlist folder of the listener's library is in, at the top: where to start going down from. It is asked for with its children, unless options.include names what to include instead: against the live API on 18 October 2026, Apple answered the documented request, which names nothing to include, with no folder at all, data and meta.filters.identity.playlistsroot both empty. Asked with an include, it answered with the root, p.playlistsroot, which has no attributes.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

options?

tRootLibraryPlaylistFolderOptions

What to send beside the folder: its children, unless include names what to send instead.

Returns

Promise<tLibraryPlaylistFoldersResponse>

What Apple answered: the root folder under data, with its first page of children under relationships.

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.