Endpoints
Get or list playlists
Query Parameters
lang?string
Preferred locale string such as en-US. Implementations may ignore localization, but en-US is the recommended default and fallback.
Default
"en-US"ids?string
Comma-separated resource IDs.
include?string
Comma-separated relationships to include. Includes are only one level deep. Valid values depend on the endpoint.
view?string
Apply the same view to the main resource and included relationships.
Value in
"minimal"view[playlists]?string
View mode for playlists.
Value in
"minimal"view[songs]?string
View mode for songs.
Value in
"minimal"limit?integer
Page size.
Default
25Range
1 <= value <= 25offset?integer
Number of items to skip.
Default
0Range
0 <= valuesort?string
Sort playlists. Prefix with - for descending.
Value in
"name" | "-name" | "date_added" | "-date_added"filter[genres]?string
Comma-separated genres filter.
limit[tracks]?integer
Limit included tracks.
Range
1 <= value <= 25Response Body
application/json
application/json
curl -X GET "http://localhost:8080/api/playlists"{
"data": [
{
"id": "string",
"type": "playlists",
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"meta": {},
"relationships": {}
}
],
"songs": [
{
"meta": {},
"instance": {},
"relationships": {}
}
]
}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"meta": {},
"instance": {},
"relationships": {}
}
],
"artists": [
{
"meta": {},
"relationships": {}
}
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
]
}
}
],
"meta": {
"limit": 0,
"offset": 0,
"has_next_page": true
}
}{
"error": {
"code": 0,
"title": "string",
"message": "string",
"trace_id": "string"
}
}