HAQM Music Web API

Web API User V1.0

Important: These HAQM Music APIs are currently in a closed Beta. Please check back soon for updates.

Important: These HAQM Music documents are in preview status. Be aware that content may change. Please use the developer forum for any questions or comments.

User

Get HAQM Music data related to users.

Get Current User
Update Current User
Get Current User's Library Tracks
Get Current User Followers
Get Current User's Followed Users
Get Current User's Followed Playlists
Add Followed Artist For Current User
Remove Followed Artist From Current User
Add Followed User For Current User
Remove Followed User From Current User
Get Current User's Followed Podcast Shows
Get User
Get Multiple Users
Get User's Followers
Get User's Followed Users
Get User's Followed Artists
Get User's Followed Podcast Shows

Current User

Get Current User

GET

/me

Authorization Scope: [music::profile]

Get detailed information about the current HAQM Music user (including their username and subscription tier).

Example

curl --request GET '<base url>/v1/me' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Response

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user

Example

{
    "data": {
        "user": {
            "id": "k35wo4lm34masdsadevrs7a",
            "name": "Test Test",
            "handle": "test",
            "images": [
                {
                    "height": 0,
                    "width": 0,
                    "url": "http://m.media-haqm.com/images/X/l6Hv/M/el6HvxENc2mzKjp.jpg",
                    "imageType": "PROFILE"
                }
            ],
            "tier": "FREE",
            "visibility": "PUBLIC",
            "playbackVisibility": "PRIVATE",
            "url": "http://music.haqm.com/profiles/@edrega?ref=dm_ff_amazonmusic.3p",
            "countryCode": "US"
        }
    }
}

{
  "data": {
    "user": {
      "id": "k35wo4lm34masdsadevrs7a",
      "name": "Test Test",
      "images": [
        {
          "height": 0,
          "width": 0,
          "url": "http://images-na.ssl-images-haqm.com/images/profile.png"
        }
      ],
      "url": "http://music.haqm.com/profiles/k35wo4lm34maumbz2vir6xgs7a"
    }
  }
}

Update Current User

PUT

/me

Authorization Scope: [music::profile:read]

Update profile information for the current user.

Body Parameters

Name	Data Type	Required	Description
name	string	Yes	The name to update the current user with.
visibility	string	Yes	The visibility type of the user. This is an enumerated type. The allowed values are ‘PUBLIC’ and ‘PRIVATE’.
playbackVisibility	string	Yes	The visibility type of the user's playback. This is an enumerated type. The allowed values are ‘PUBLIC’ and ‘PRIVATE’.

Example

curl --request PUT '<base url>/v1/me' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>' \
--header 'Content-Type: application/json' \
--data \
'{
  "name": "New Name",
  "visibility": "PUBLIC",
  "playbackVisibility": "PUBLIC"
}'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
updateUser	User	No	Data about the updated HAQM Music user

Example

{
	"id": "hznmiapzd7e43yl53qp6tvuw44",
	"name": null,
	"images": [
		{
			"height": 0,
			"width": 0,
			"url": "http://images-na.ssl-images-haqm.com/images/S/amazon-avatars-global/default._CR0,0,1024,1024_SX500__UX358_FMpng_QL85_.png",
			"imageType": "PROFILE"
		}
	],
	"tier": "UNLIMITED",
	"visibility": "PUBLIC",
	"playbackVisibility": null,
	"url": "http://music.haqm.com/profiles/hznmiapzd7e43yl53qp6tvuw44?ref=dm_ff_amazonmusic.3p"
}

Get Current User's Library Tracks

GET

/me/library/tracks

Authorization Scope: [music::profile:read]

Get a list of library tracks for the current HAQM Music user. Optional parameters can be used to limit the number of tracks returned.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
trackIds	string	No	A comma-separated list of track IDs. This method will check the user’s Like status against the specified tracks (if provided).
limit	number	No	The maximum number of tracks to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/me/library/tracks' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user, including their library tracks

Example

{
  "data": {
    "user": {
      "id": "6ozjgidgbvjdv3j6dd5jm7ipom",
      "libraryTracks": {
        "pageInfo": {
          "hasNextPage": false
        },
        "edgeCount": 2,
        "edges": [
          {
            "uploaded": false,
            "purchased": false,
            "node": {
              "id": "B07B62ZK5S"
            }
          },
          {
            "uploaded": false,
            "purchased": false,
            "node": {
              "id": "B06VWVWDDH"
            }
          }
        ]
      }
    }
  }
}

Get Current User Followers

GET

/me/followers

Authorization Scope: [music::favorites:read]

Get the current HAQM Music user’s list of followers. Optional parameters can be used to limit the number of followers returned.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of followers to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/me/followers' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user, including followers

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhyb2welrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followers": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAIAAAACc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD54RobqBQAeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "uj7wxenmftr26zlg7eo4maa744",
              "name": "Jane M",
              "url": "http://music.haqm.com/profiles/uj7wxenmftr26zlg7eo4maa744"
            }
          },
          {
            "node": {
              "id": "zz2hu7x4v2u2bhzyh5bsb4xvje",
              "name": "Amit",
              "url": "http://music.haqm.com/profiles/zz2hu7x4v2u2bhzyh5bsb4xvje"
            }
          }
        ]
      }
    }
  }
}

Get Current User's Followed Users

GET

/me/followed/users

Authorization Scope: [music::favorites:read]

Get the current user’s list of followed users. Optional parameters can be used to limit the number of followed users to return.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of users to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/me/followed/users' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user, including followed users

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhyb2welrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followedUsers": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAUAAAAFc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD55G8Qgq9AeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "ajdzyygpbolfqstxggxmqn4ouu",
              "name": "Victor Max",
              "url": "http://music.haqm.com/profiles/lgwup3erbjovmjxwf6sb2hm35m"
            }
          },
          {
            "node": {
              "id": "lgwup3erbjovmjxwf6sb2hm35m",
              "name": "El Victor",
              "url": "http://music.haqm.com/profiles/lgwup3erbjovmjxwf6sb2hm35m"
            }
          }
        ]
      }
    }
  }
}

Get Current User's Followed Playlists

GET

/me/followed/playlists

Authorization Scope: [music::favorites:read]

Get the current HAQM Music user’s list of followed playlists. Optional parameters can be used to limit the number of playlists returned.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
playlistIds	string	No	Playlist IDs to limit the results to.
limit	number	No	The maximum number of artists to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/me/followed/playlists' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user, including followed playlists

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhyb2welrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followedPlaylists": {
        "pageInfo": {
          "hasNextPage": false
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "B01LS62KK2",
              "name": "CLASSIC ROCK HITS",
              "url": "http://music.haqm.com/playlists/B01LS62KK2"
            }
          },
          {
            "node": {
              "id": "B01LOXC1UI",
              "name": "HIP-HOP CLASSICS",
              "url": "http://music.haqm.com/playlists/B01LOXC1UI"
            }
          }
        ]
      }
    }
  }
}

Add Followed Artist For Current User

PUT

/me/followed/artists/{id}

Authorization Scope: [music::favorites]

Add an artist to the current user's followed artist list.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The HAQM Music ID of the artist to make the current user follow.

Example

curl --request PUT <base url>/v1/me/followed/artists/B000QKGN8W
--header 'x-api-key: <your security profile ID>' 
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
followedArtist	Response	No	Data about the HAQM Music artist that has been followed

Example

{
  "data": {
    "followArtist": {
      "artist": {
        "id": "B000QKGN8W",
        "name": "Coldplay",
        "url": "http://music.haqm.com/artists/B000QKGN8W"
      },
      "followState": "FOLLOW"
    }
  }
}

Remove Followed Artist From Current User

DELETE

/me/followed/artists/{id}

Authorization Scope: [music::favorites]

Remove the current user as a follower of the specified artist.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The HAQM Music ID of the artist to make the current user un-follow.

Example

curl --request DELETE <base url>/v1/me/followed/artists/B000QKGN8W
--header 'x-api-key: <your security profile ID>' 
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
unfollowArtist	Response	No	Data about the HAQM Music artist that has been un-followed

Example

{
  "data": {
    "followArtist": {
      "artist": {
        "id": "B000QKGN8W",
        "name": "Coldplay",
        "url": "http://music.haqm.com/artists/B000QKGN8W"
      },
      "followState": "UNFOLLOW"
    }
  }
}

Add Followed User For Current User

PUT

/me/followed/users/{id}

Authorization Scope: [music::favorites]

Add a specified user to the the current user's list of followed users.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The HAQM Music ID of the user to make the current user follow.

Example

curl --request PUT <base url>/v1/me/followed/users/zz2hu7x4ert4gferzyh5bsb4xvje
--header 'x-api-key: <your security profile ID>' 
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
followUser	Response	No	Data about the HAQM Music user that has been followed

Example

{
  "data": {
    "followUser": {
      "user": {
        "id": "zz2hu7x4ert4gferzyh5bsb4xvje",
        "name": "Amit",
        "url": "http://music.haqm.com/profiles/zz2hu7x4v2u2bhzyh5bsb4xvje"
      },
      "followState": "FOLLOW"
    }
  }
}

Remove Followed User From Current User

DELETE

/me/followed/users/{id}

Authorization Scope: [music::favorites]

Remove a specified user from the the current user's list of followed users.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The user ID of the user to unfollow.

Example

curl --request DELETE <base url>/v1/me/followed/users/zz2hu7x4v2ureqerb4xvje
--header 'x-api-key: <your security profile ID>' 
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
unfollowUser	Response	No	Data about the HAQM Music user that has been unfollowed

Example

{
  "data": {
    "unfollowUser": {
      "user": {
        "id": "zz2hu7x4v2ureqerb4xvje",
        "name": "Amit",
        "url": "http://music.haqm.com/profiles/zz2hu7x4v2u2bhzyh5bsb4xvje"
      },
      "followState": "UNFOLLOW"
    }
  }
}

Get Current User's Followed Podcast Shows

GET

/me/followed/podcasts/shows

Authorization Scope: [music::favorites:read]

Get the current user’s list of followed podcast shows. Optional parameters can be used to limit the number of shows returned.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of podcast shows to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

http://api.music.amazon.dev/v1/albums?ids=abcd1234,XYZABC123

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user and their followed podcast shows

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhyb2welrqsrtrhdvaa",
      "name": "Tony Starked",
      "followedPodcastShows": {
        "pageInfo": {
          "hasNextPage": false
        },
        "edgeCount": 3,
        "edges": [
          {
            "node": {
              "id": "8bfa8155-888b-4553-acd3-8f22d43b4c9e",
              "title": "DISGRACELAND",
              "url": "http://music.haqm.com/podcasts/8bfa8155-888b-4553-acd3-8f22d43b4c9e/DISGRACELAND"
            }
          },
          {
            "node": {
              "id": "7e8c8b9f-ab40-49ad-9efb-fdb0960979a8",
              "title": "One Hundred Percent with Marcus Lemonis",
              "url": "http://music.haqm.com/podcasts/7e8c8b9f-ab40-49ad-9efb-fdb0960979a8/One-Hundred Percent with Marcus Lemonis"
            }
          },
          {
            "node": {
              "id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
              "title": "Crime Junkie",
              "url": "http://music.haqm.com/podcasts/d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0/Crime-Junkie"
            }
          }
        ]
      }
    }
  }
}

Non-current User

Get User

GET

/users/{id}

Authorization Scope: [music::catalog]

Get public profile information about a specified HAQM Music user. Includes name, tier, and more.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The requested user’s HAQM Music ID.

Example

curl --request GET '<base url>/v1/users/k35wo4lm34masdsadevrs7a' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the specified HAQM Music user

Example

{
  "data": {
    "user": {
      "id": "k35wo4lm34masdsadevrs7a",
      "name": "Test Test",
      "images": [
        {
          "height": 0,
          "width": 0,
          "url": "http://images-na.ssl-images-haqm.com/images/profile.png"
        }
      ],
      "tier": "UNLIMITED",
      "visibility": "PRIVATE",
      "playbackVisibility": "PRIVATE",
      "url": "http://music.haqm.com/profiles/k35wo4lm34maumbz2vir6xgs7a"
    }
  }
}

Get Multiple Users

GET

/users

Authorization Scope: [music::catalog]

Get public profile information for multiple HAQM Music users, identified by comma-separated IDs. This includes name, tier, and more.

Query Parameters

Name	Data Type	Required	Description
ids	string	Yes	A comma-separated list of the HAQM Music IDs for the user. Maximum: 100 IDs.

Example

curl --request GET '<base url>/v1/users?ids=k35wo4lm34masdsadevrs7a,q4rno6sdfhqers7dnoiq' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Response

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User[]	No	Data about the specified HAQM Music users

Example

{
  "data": {
    "users": [
      {
        "id": "k35wo4lm34maumbz2vir6xgs7a",
        "name": "Test Test",
        "images": [
          {
            "height": 0,
            "width": 0,
            "url": "http://images-na.ssl-images-haqm.com/images/profile.png"
          }
        ],
        "url": "http://music.haqm.com/profiles/k35wo4lm34maumbz2vir6xgs7a"
      },
      {
        "id": "q4rno6sdfhqers7dnoiq",
        "name": "Test Test",
        "images": [
          {
            "height": 0,
            "width": 0,
            "url": "http://images-na.ssl-images-haqm.com/images/profile.png"
          }
        ],
        "url": "http://music.haqm.com/profiles/q4rno6sdfhqers7dnoiq"
      },
    ]
  }
}

Get User's Followers

GET

/users/{id}/followers

Authorization Scope: [music::catalog]

Get a list of a specified public HAQM Music user’s followers. Optional parameters can be used to limit the number of followers returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The ID of the HAQM Music user whose followers should be retrieved.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of followers to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/users/zqll6htnhy34fqsrtrhdvaa/followers?limit=2' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user including their followers

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhy34fqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followers": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAIAAAACc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD54RobqBQAeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "uj7wxenmftr26zlg7eo4maa744",
              "name": "Jane M",
              "url": "http://music.haqm.com/profiles/uj7wxenmftr26zlg7eo4maa744"
            }
          },
          {
            "node": {
              "id": "zz2hu7x4v2u2bhzyh5bsb4xvje",
              "name": "Amit",
              "url": "http://music.haqm.com/profiles/zz2hu7x4v2u2bhzyh5bsb4xvje"
            }
          }
        ]
      }
    }
  }
}

Get User's Followed Users

GET

/users/{id}/followed/users

Authorization Scope: [music::catalog]

Get a list of a specified public HAQM Music user’s followed users. Optional parameters can be used to limit the number of followed users returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The ID of the HAQM Music user whose followed users should be retrieved.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of followed users to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/users/zqll6htnhybrewrqsrtrhdvaa/followed?limit=2' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user including their followed users

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhybrewrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followedUsers": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAUAAAAFc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD55G8Qgq9AeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "ajdzyygpbolfqstxggxmqn4ouu",
              "name": "Victor Max",
              "url": "http://music.haqm.com/profiles/lgwup3erbjovmjxwf6sb2hm35m"
            }
          },
          {
            "node": {
              "id": "lgwup3erbjovmjxwf6sb2hm35m",
              "name": "El Victor",
              "url": "http://music.haqm.com/profiles/lgwup3erbjovmjxwf6sb2hm35m"
            }
          }
        ]
      }
    }
  }
}

Get User's Followed Artists

GET

/users/{id}/followed/artists

Authorization Scope: [music::catalog]

Get a list of a public HAQM Music user’s followed artists. Optional parameters can be used to limit the number of followed artists returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The ID of the HAQM Music user whose followed artists should be retrieved.

Query Parameters

Name	Data Type	Required	Description
artistIds	string	No	Artist IDs to limit the results to.
limit	number	No	The maximum number of followed users to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/users/zqll6htnhybrewrqsrtrhdvaa/followed/artists?limit=2' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user including their followed artists

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhybrewrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followedArtists": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAIAAAACc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD55C0ZRboAeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "B000QKGN8W",
              "name": "Coldplay",
              "url": "http://music.haqm.com/artists/B000QKGN8W"
            }
          },
          {
            "node": {
              "id": "B000S2A8NE",
              "name": "XYZ",
              "url": "http://music.haqm.com/artists/B000S2A8NE"
            }
          }
        ]
      }
    }
  }
}

Get User's Followed Podcast Shows

GET

/users/{id}/followed/podcasts/shows

Authorization Scope: [music::catalog]

Get a list of a public HAQM Music user’s followed podcast shows. Optional parameters can be used to limit the number of shows returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The ID of the HAQM Music user whose followed podcast shows should be retrieved.

Query Parameters

Name	Data Type	Required	Description
artistIds	string	No	Artist IDs to limit the results to.
limit	number	No	The maximum number of followed podcast shows to return (default: 36). Minimum of 1, maximum of 36.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/users/zqll6htnhybrewrqsrtrhdvaa/followed/podcasts/shows?limit=2' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the specified HAQM Music user and their followed podcast shows

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhybrewrqsrtrhdvaa",
      "name": "Tony Starked",
      "followedPodcastShows": {
        "pageInfo": {
          "hasNextPage": false
        },
        "edgeCount": 3,
        "edges": [
          {
            "node": {
              "id": "8bfa8155-888b-4553-acd3-8f22d43b4c9e",
              "title": "DISGRACELAND",
              "url": "http://music.haqm.com/podcasts/8bfa8155-888b-4553-acd3-8f22d43b4c9e/DISGRACELAND"
            }
          },
          {
            "node": {
              "id": "7e8c8b9f-ab40-49ad-9efb-fdb0960979a8",
              "title": "One Hundred Percent with Marcus Lemonis",
              "url": "http://music.haqm.com/podcasts/7e8c8b9f-ab40-49ad-9efb-fdb0960979a8/One-Hundred Percent with Marcus Lemonis"
            }
          },
          {
            "node": {
              "id": "d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0",
              "title": "Crime Junkie",
              "url": "http://music.haqm.com/podcasts/d6e3946e-6b3f-48dc-a3ae-fdc7c9d699f0/Crime-Junkie"
            }
          }
        ]
      }
    }
  }
}