Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional country

country: string

The country of the user, as set in the user’s account profile. An ISO 3166-1 alpha-2 country code. This field is only available when the current user has granted access to the user-read-private scope

Optional display_name

display_name: null | string

The name displayed on the user’s profile

Optional email

email: string

The user’s email address, as entered by the user when creating their account. This field is only available when the current user has granted access to the user-read-email scope.

⚠️Important: This email address is unverified, there is no proof that it actually belongs to the user

Optional explicit_content

The user’s explicit content settings. This field is only available when the current user has granted access to the user-read-private scope.

external_urls

external_urls: ExternalUrlObject

Known public external URLs for this user

Optional followers

followers: FollowersObject

Information about the followers of this user

href

href: string

A link to the Web API endpoint for this user

id

id: string

The Spotify user ID for this user

Optional images

images: ImageObject[]

The user’s profile image

product

product: string

The user’s Spotify subscription level: premium, free, etc. This field is only available when the current user has granted access to the user-read-private scope.

⚠️Note: The subscription level open can be considered the same as free

type

type: string

The object type: user

uri

uri: string

The Spotify URI for this user

Legend

  • Property

Generated using TypeDoc