Viewer API › Playlists Legacy

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns a playlist identified with the given id.

Resource URL

https://api.toornament.com/viewer/v2/playlists/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

Path parameters

• id

  string

  The id of the playlist to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Playlist retrieved.

Example

{
    "id": "378426939508809728",
    "name": "The Paradise Tour",
    "description": "My description \\n on multiple lines."
}

Structure (object)

• id

  string

  A unique identifier for the playlist.

  Example: "378426939508809728"

• name

  string

  The name of the playlist.

  Max. length: 30 characters

  Example: "The Paradise Tour"

• description

  string|null

  A description of the playlist.

  Max. length: 1,500 characters

  Example: "My description \n on multiple lines."