Collection
Retrieve multiple images for a given ref.
Endpoint URL
/api/:type/:id/images
HTTP Method
GET
Authentication
Client ID required. See how to authenticate public resources here.
Parameters
| Name | Required | Description | Example |
|---|---|---|---|
| type | required | The type of the entity the image is associated to. (artists, albums, playlists, users, genres, curators) | playlists |
| id | required | Unique id of the type
|
pl102832372763984640 |
| limit | optional | Specifies the maximum number of records to retrieve. You are guaranteed to get at most this number of results, but you may get fewer. If set to zero or less, returns nothing. Maximum value is 200 (i.e., if greater than 200, returns only 200). If not supplied, defaults to 20. | 20 |
| offset | optional | Integer offset into results, 0 based. Defaults to 0. | 0 |
Response Elements
| Response | Description |
|---|---|
| code |
Beats API response code. If successful, code is 'OK'. Otherwise it will be an error code. |
| data |
List of images. Each element is an image object: |
|
type |
The entity type of the API object |
|
id |
Unique ID of the activity |
|
mime_type |
The image's mime type. |
|
location_prefix |
The images location prefix. Used to build image URL. |
|
parent |
The parent type. |
|
Object with keys corresponding to referenced object types, and values providing the bare information needed for linking to the objects. |
Errors
| InvalidArgument [409] |
Invalid type <type> |
|
Example Response
{
"code":"OK",
"data":[
{
"type":"image",
"id":"img0000000000",
"description":"test",
"location_prefix":"daisy-images.s3.amazonaws.com",
"intent":"default",
"parent":{
"ref_type":"artist",
"id":"ar9999999999",
"display":""
}
}
],
"info":{
"offset":0,
"count":1,
"total":1
}
}
