Get User's Profile

client.users.retrieveProfile(, ?): UserRetrieveProfileResponse { id, display_name, external_urls, 6 more }

GET/users/{user_id}

Get public profile information about a Spotify user.

ParametersExpand Collapse

userID: string

The user's Spotify user ID.

ReturnsExpand Collapse

UserRetrieveProfileResponse { id, display_name, external_urls, 6 more }

id?: string

The Spotify user ID for this user.

display_name?: string | null

The name displayed on the user's profile. null if not available.

external_urls?: ExternalURLObject { published, spotify }

Known public external URLs for this user.

published?: boolean

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

spotify?: string

The Spotify URL for the object.

followers?: FollowersObject { href, published, total }

Information about the followers of this user.

href?: string | null

This will always be set to null, as the Web API does not support it at the moment.

published?: boolean

total?: number

The total number of followers.

href?: string

A link to the Web API endpoint for this user.

images?: Array<ImageObject { height, url, width, published } >

The user's profile image.

height: number | null

The image height in pixels.

url: string

The source URL of the image.

width: number | null

The image width in pixels.

published?: boolean

type?: "user"

The object type.

uri?: string

The Spotify URI for this user.

Get User's Profile

import Spotted from 'spotted-ts';

const client = new Spotted({
  accessToken: process.env['SPOTIFY_ACCESS_TOKEN'], // This is the default and can be omitted
});

const response = await client.users.retrieveProfile('smedjan');

console.log(response.id);

{
  "id": "id",
  "display_name": "display_name",
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "followers": {
    "href": "href",
    "published": true,
    "total": 0
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "published": true,
  "type": "user",
  "uri": "uri"
}

Returns Examples

{
  "id": "id",
  "display_name": "display_name",
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "followers": {
    "href": "href",
    "published": true,
    "total": 0
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "published": true,
  "type": "user",
  "uri": "uri"
}