Skip to the content
Get an API key
  1. API reference
  2. Connect your users

Get a connected user

GET/public/integrations/user/{integrationUserUUID}
Core + Managed TransfersAuthBasicTokenDevTokenDocsSession

Reads one connected user of your account. With Client Secret (Basic) authentication the answer also holds the raw service tokens (authData), refreshed when they expire within a minute. Every other credential gets the profile only.

Path parameters

integrationUserUUID
uuidrequired

The connected user: the integrationUserUUID from the sign-in callback.

Response

200application/json · IntegrationUserResponseOK
integrationUser
IntegrationUserWithAuthData
required
integrationUser.uuid
uuid
requiredThe integrationUserUUID. Use it in every /api/{integrationUserUUID}/... call.
integrationUser.integrationUserId
string
requiredThe user's id on the music service.
integrationUser.name
string | null
required
integrationUser.email
string | null
required
integrationUser.imageUrl
string | null
required
integrationUser.country
string | null
requiredISO 3166-1 alpha-2 country of the account, when the service tells us.
integrationUser.authData
object
The raw music-service credentials, without the refresh token. Only in answers to a Client Secret (Basic) or one-time-token call.
integrationUser.authDataExpiresAt
number | null
When authData expires, in milliseconds since the epoch.
integration
object
required
integration.type
string
requiredThe music service of this user.
Example answer
{
  "integrationUser": {
    "uuid": "3f0b8c1e-6a4d-4c7a-9a55-2f1e7d9b0c11",
    "integrationUserId": "mica.nowak",
    "name": "Mica Nowak",
    "email": "[email protected]",
    "imageUrl": "https://images.example.com/mica.jpg",
    "country": "PL",
    "authData": {},
    "authDataExpiresAt": 0
  },
  "integration": {
    "type": "spotify"
  }
}

Errors

401

The tokens could not be refreshed. Send the user to sign in again.

404

Your account has no connected user with this uuid.