Retrieve details for a single playlist.

GET

https://demo.azuracast.com/api/station/{station_id}/playlist/{id}

curl -X GET 'https://demo.azuracast.com/api/station/0/playlist/0' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/station/0/playlist/0', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/playlist/0',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "id": 0,
  "name": "Test Playlist",
  "description": "A playlist containing my favorite songs",
  "type": "default",
  "source": "songs",
  "order": "random",
  "remote_url": "https://remote-url.example.com/stream.mp3",
  "remote_type": "stream",
  "remote_buffer": 0,
  "is_enabled": true,
  "is_jingle": false,
  "play_per_songs": 5,
  "play_per_minutes": 120,
  "play_per_hour_minute": 15,
  "weight": 3,
  "include_in_requests": true,
  "include_in_on_demand": true,
  "backend_options": "interrupt,loop_once,single_track,merge",
  "avoid_duplicates": true,
  "preserve_queue_on_restart": false,
  "schedule_items": [],
  "podcasts": [],
  "playlists": [],
  "links": {},
  "short_name": "string",
  "num_songs": 25,
  "total_length": 3600,
  "playlist_groups": [
    {
      "id": 1,
      "name": "My Group"
    }
  ]
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Parameters

station_idinteger | stringrequiredpath

idinteger<int64>requiredpath

Playlist ID

Response

200OKHasAutoIncrementId & object & HasLinks & Api_StationPlaylistComputedFields

Success

Response fields application/json

idintegerrequiredread only

namestring

Example

Test Playlist

descriptionstring | null

Example

A playlist containing my favorite songs

typePlaylistTypesdefaultonce_per_x_songsonce_per_x_minutesonce_per_hourcustom

sourcePlaylistSourcessongsplaylistsremote_urlrequests

orderPlaylistOrdersrandomshufflesequential

remote_urlstring | null

Example

https://remote-url.example.com/stream.mp3

remote_typePlaylistRemoteTypes | null

Show child attributes

One of

PlaylistRemoteTypesstreamplaylistother

Example

stream

remote_bufferinteger

The total time (in seconds) that Liquidsoap should buffer remote URL streams.

Example

is_enabledboolean

Example

true

is_jingleboolean

If yes, do not send jingle metadata to AutoDJ or trigger web hooks.

Example

false

play_per_songsinteger

Example

play_per_minutesinteger

Example

play_per_hour_minuteinteger

Example

weightinteger

The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights.

Example

include_in_requestsboolean

Example

true

include_in_on_demandboolean

Whether this playlist’s media is included in ‘on demand’ download/streaming if enabled.

Example

true

backend_optionsArray<string>

Example

interrupt,loop_once,single_track,merge

avoid_duplicatesboolean

Example

true

preserve_queue_on_restartboolean

Don’t reset this playlist’s queue when the station is restarted or its configuration is rewritten.

Example

false

schedule_itemsArray<any>

podcastsArray<any>

playlistsArray<any>

linksobjectread only

Show child attributes

[key: string]string

short_namestringread only

A URL-safe version of the playlist name.

num_songsinteger | nullread only

The number of songs in the playlist, if it is a song-based playlist.

Example

total_lengthnumber<float> | nullread only

The total length of the playlist in seconds, if it is a song-based playlist.

Example

playlist_groupsArray<Api_StationPlaylistParentGroup>read only

The parent groups that this playlist is a member of.

Show child attributes

idintegerrequired

The unique identifier of the parent group.

Example

namestringrequired

The name of the parent group.

Example

My Group

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

404Not FoundApi_Error

Record not found.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey