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

Get the result of a sign-in

GET/public/integrations/auth/{authModelUUID}
Core + Managed TransfersAuthBasicTokenDevTokenDocsSession

Reads one sign-in attempt of your account and the user it connected. authData is in the answer only for a Client Secret call or with a valid oneTimeToken from the callback.

Path parameters

authModelUUID
stringrequired

Query parameters

oneTimeToken
string

The one-time token from the callback. It must belong to your account and to this sign-in.

Response

200application/json · AuthModelResultResponseOK
authModel
AuthModel
required
authModel.uuid
uuid
required
authModel.status
string
requiredOne of: initialised, success, error
authModel.error
string | null
required
authModel.errorType
string | null
requiredOne of: accessDenied, notAllowedInYourCountry, missingScopes, deniedSubscriptionTier, null
integrationUser
IntegrationUserWithAuthData | null
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.
Example answer
{
  "authModel": {
    "uuid": "5b0c6f0e-2c8a-4d0e-9a51-7e3f1c2d9b44",
    "status": "initialised",
    "error": "string",
    "errorType": "accessDenied"
  },
  "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
  }
}

Errors

403

The one-time token belongs to another account or another sign-in.

404

Your account has no sign-in attempt with this uuid.