Skip to content
Client
Server

Reference / @open-music-sdk/client-catalog / getRecordLabelView

Function: getRecordLabelView() ​

ts
function getRecordLabelView<K>(
   client, 
   id, 
   name, 
   options?
): Promise<tViewPage<tRecordLabelViews, K>>;

Defined in: clients/client-catalog/src/resources.ts:952

One view of a record label, such as latest-releases, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.

Type Parameters ​

K ​

K extends "latest-releases" | "top-releases"

Parameters ​

client ​

tAppleMusicClient

The client to ask with.

id ​

string

The record label's id.

name ​

K

The view's name, one of the record label's as the type has them; Apple says whether there is such a one.

options? ​

tViewOptions<tRecordLabelViews, K>

The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.

Returns ​

Promise<tViewPage<tRecordLabelViews, K>>

What Apple answered: the first page, with its own attributes where they were asked for and next where there is more; maxPages plays no part.

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, if the client has no storefront to ask in, 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.

MIT licensed. Not affiliated with, endorsed by, or sponsored by Apple Inc. Apple Music and MusicKit are trademarks of Apple Inc.