getArtists
Returns all artists.
Categories:
http://your-server/rest/getArtists Since 1.8.0
Similar to getIndexes, but organizes music according to ID3 tags.
Parameters
| Parameter | Req. | OpenS. | Default | Comment |
|---|---|---|---|---|
musicFolderId | No | If specified, only return artists in the music folder with the given ID. See getMusicFolders. | ||
role | No | Yes | Repeat this parameter to filter the returned artists by one or more roles. Requires the Artist role filter extension. |
OpenSubsonic
If the server supports the Artist role filter extension, it must accept the role parameter and filter the returned artists accordingly.
role may be repeated to request several roles, using the values found in the ArtistID3 roles field (e.g. albumartist, artist, composer). An artist is returned if it has any of the requested roles. The special value all returns every artist regardless of role.
When role is omitted the server returns what it does today, so the extension is purely additive and existing clients are unaffected.
Example
http://your-server/rest/getArtists.view?&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=jsonResult
A subsonic-response element with a nested artists element on success.
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"type": "AwesomeServerName",
"serverVersion": "0.1.3 (tag)",
"openSubsonic": true,
"artists": {
"ignoredArticles": "The An A Die Das Ein Eine Les Le La",
"index": [
{
"name": "C",
"artist": [
{
"id": "100000016",
"name": "CARNÚN",
"coverArt": "ar-100000016",
"albumCount": 1
},
{
"id": "100000027",
"name": "Chi.Otic",
"coverArt": "ar-100000027",
"albumCount": 0
}
]
},
{
"name": "I",
"artist": [
{
"id": "100000013",
"name": "IOK-1",
"coverArt": "ar-100000013",
"albumCount": 1
}
]
}
]
}
}
}{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"artists": {
"ignoredArticles": "The An A Die Das Ein Eine Les Le La",
"index": [
{
"name": "C",
"artist": [
{
"id": "100000016",
"name": "CARNÚN",
"coverArt": "ar-100000016",
"albumCount": 1
},
{
"id": "100000027",
"name": "Chi.Otic",
"coverArt": "ar-100000027",
"albumCount": 0
}
]
},
{
"name": "I",
"artist": [
{
"id": "100000013",
"name": "IOK-1",
"coverArt": "ar-100000013",
"albumCount": 1
}
]
}
]
}
}
}| Field | Type | Req. | OpenS. | Details |
|---|---|---|---|---|
artists | artists | Yes | The artist list |