Sections

Theme switcher

Get Settings

Header Parameters

StoreIdstring Required

StoreId API key provided by Tuned Global to authenticate and authorize access to the service

Authorizationstring Required

Bearer token

Query Parameters

applicationIdinteger Required

Unique identifier for the application making the API request

Path Parameters

idinteger Required

Unique identifier of the user whose settings are being retrieved

Response

200
Object

OK

Response Attributes

AllowStreamsboolean

Specifies whether the user is allowed to stream content in real-time

LimitSkipsboolean

The total allowed number of track skips for the user within a defined period

AdFirstMinutesinteger

Duration in minutes at the start of playback during which ads are shown

AdIntervalMinutesinteger

Interval in minutes between consecutive advertisements during playback

AllowPurchaseboolean

Indicates if the user is permitted to make in-app purchases

AllowAlbumNavigationboolean

Determines if users can navigate through albums within the application

AllowOfflineboolean

Specifies whether the user is permitted to download content for offline use

AllowSyncboolean

Controls whether the user can synchronize content across devices

SyncCutOffDaysinteger

Number of days after which content synchronization is restricted or disabled

MaxSkipsPerHourinteger

The maximum number of track skips a user can perform within one hour

LimitPlaysboolean

The total number of times a user can play tracks before restrictions apply

MonthlyPlayLimitinteger

The maximum number of track plays allowed for the user per month

AdProviderstring

The configured advertisement service provider for the user’s content stream

TracksPerAdinteger

The number of music tracks played between each advertisement

InterstitialIdstring

Identifier for the interstitial ad configured for the user’s experience

FacebookUrlstring

The user's associated Facebook profile or page URL

TwitterUrlstring

The user's associated Twitter profile or page URL

InstagramUrlstring

The user's associated Instagram profile or page URL

YoutubeUrlstring

The user's associated YouTube channel or profile URL

SupportEmailstring

The email address designated for user support inquiries

DMCARulesboolean

Flags indicating compliance with DMCA regulations applicable to the user’s content

readOnly
StreamProviderstring

The streaming service provider assigned to deliver content to the user

readOnly
CarouselIntervalinteger

Duration in seconds between slide transitions in the app’s carousel display

SuggestionsSortBystring

The criterion used to sort suggested content presented to the user

LimitDownloadsboolean

The maximum number of downloads a user is allowed within a specified timeframe

MaxDownloadLimitinteger

The upper limit on the number of downloads a user can perform overall

AudioQualityEnabledForAllboolean

Indicates whether high-quality audio streaming is enabled for all users

AllowLyricsboolean

Indicates if song lyrics are accessible to the user during playback

AllowChordChartsboolean

Indicates whether the user has permission to access and display chord chart features within the application

EnableDataPrivacyboolean

Specifies if enhanced data privacy settings are activated for the user's account, controlling data collection and sharing behaviors

Was this section helpful?

GET

/

Select
1

Response

Error Codes

403

User is logged in but does not have read permission on account data

400

applicationId is missing or not a valid whole number

400

No settings could be found for this user/application/store combination

Was this section helpful?