Skip to content
DocumentationAPI Reference

Audiobooks

Get an Audiobook
GET/audiobooks/{id}
Get Audiobook Chapters
GET/audiobooks/{id}/chapters
ModelsExpand Collapse
SimplifiedChapterObject = object { id, audio_preview_url, chapter_number, 18 more }
id: string

The Spotify ID for the chapter.

Deprecatedaudio_preview_url: string

A URL to a 30 second preview (MP3 format) of the chapter. null if not available.

chapter_number: number

The number of the chapter

description: string

A description of the chapter. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

duration_ms: number

The chapter length in milliseconds.

explicit: boolean

Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown).

external_urls: ExternalURLObject { published, spotify }

External URLs for this chapter.

published: optional boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

spotify: optional string

The Spotify URL for the object.

href: string

A link to the Web API endpoint providing full details of the chapter.

html_description: string

A description of the chapter. This field may contain HTML tags.

images: array of ImageObject { height, url, width, published }

The cover art for the chapter in various sizes, widest first.

height: number

The image height in pixels.

url: string

The source URL of the image.

width: number

The image width in pixels.

published: optional boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

is_playable: boolean

True if the chapter is playable in the given market. Otherwise false.

languages: array of string

A list of the languages used in the chapter, identified by their ISO 639-1 code.

name: string

The name of the chapter.

release_date: string

The date the chapter was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

release_date_precision: "year" or "month" or "day"

The precision with which release_date value is known.

Accepts one of the following:
"year"
"month"
"day"
type: "episode"

The object type.

uri: string

The Spotify URI for the chapter.

available_markets: optional array of string

A list of the countries in which the chapter can be played, identified by their ISO 3166-1 alpha-2 code.

published: optional boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

restrictions: optional ChapterRestrictionObject { published, reason }

Included in the response when a content restriction is applied.

published: optional boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

reason: optional string

The reason for the restriction. Supported values:

  • market - The content item is not available in the given market.
  • product - The content item is not available for the user's subscription type.
  • explicit - The content item is explicit and the user's account is set to not play explicit content.
  • payment_required - Payment is required to play the content item.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

resume_point: optional ResumePointObject { fully_played, published, resume_position_ms }

The user's most recent position in the chapter. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.

fully_played: optional boolean

Whether or not the episode has been fully played by the user.

published: optional boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

resume_position_ms: optional number

The user's most recent position in the episode in milliseconds.