Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional additional_types

additional_types: string

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode

⚠️Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future. In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object

Optional fields

fields: string

A comma-separated list of the fields to return. If omitted, all fields are returned. For example, to get just the playlist's description and URI: fields=description,uri

A dot separator can be used to specify non-reoccurring fields, while parentheses can be used to specify reoccurring fields within objects. For example, to get just the added date and user ID of the adder: fields=tracks.items(added_at,added_by.id)

Use multiple parentheses to drill down into nested objects. For example: fields=tracks.items(track(name,href,album(name,href)))

Fields can be excluded by prefixing them with an exclamation mark. For example: fields=tracks.items(track(name,href,album(!name,href)))

Optional limit

limit: number

The maximum number of items to return. Default: 100, Minimum: 1, Maximum: 50

market

market: string

An ISO 3166-1 alpha-2 country code. If a country code is specified, only items that are available in that market will be returned

If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter

⚠️Note: If neither market nor user country is provided, the content is considered unavailable for the client

Optional offset

offset: number

The index of the first item to return

Default: 0 (the first object)

Use with limit to get the next set of items

Legend

  • Property

Generated using TypeDoc