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

Get a hosted sign-in attempt

GET/app/integrations/{authModelUUID}
Core + Managed TransfersAuthNo credential

The state of one sign-in attempt, as the hosted pages read it. The authModelUUID comes back in the callback. It needs no credentials and never returns authData.

Path parameters

authModelUUID
uuidrequired

Response

200application/json · HostedSignInResponseOK
forwardFailures
boolean
authUrl
string
requiredThe music service's own sign-in URL for this login.
returnUrl
string
requiredWhere the browser goes when the login ends.
oneTimeToken
string | null
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
UserResponse | null
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.
user
PublicPartner
required
user.id
number
required
user.slug
string
required
user.name
string
required
user.logoFile
object | null
user.base64Logo
string | null
user.logoSquareFile
object | null
integration
PublicIntegration
requiredOne music service that the partner turned on, with its public settings.
integration.type
string
required
Example answer
{
  "forwardFailures": true,
  "authUrl": "string",
  "returnUrl": "string",
  "oneTimeToken": "string",
  "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"
  },
  "user": {
    "id": 0,
    "slug": "acme",
    "name": "Acme Music",
    "logoFile": {},
    "base64Logo": "string",
    "logoSquareFile": {}
  },
  "integration": {
    "type": "spotify"
  }
}

Errors

404

No sign-in attempt with this uuid.