Account information

Fetch a user's platform profile information

On Orchdio, you can get a user's information using their email. Depending on the platforms they have authenticated your app on, you can get access to all the user's platform (basic) profile. Fetching user information through email is useful when you have the user's email but not the user's Orchdio ID and the endpoint requires an ID. You can first fetch user's information this way and then get the Orchdio ID that you need.

You can also pass the user's Orchdio ID in the identifier instead of the email address.

This endpoint returns data that are private user data and may require you pass the necessary scopes. For example, in order to get the user's email, Spotify requires a user-read-email scope. Please consult the documentation for the platform you want to support in order to know which scopes are required for (private) user profile information.

get

Query parameters

identifierone ofRequired

The identifier of the user. This can be an email address or uuid

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

string · emailOptional

or

string · uuidOptional

Header parameters

x-orchdio-keystring · uuidRequired

Your private key

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200

Successful response

application/json

Responseany

The response returned when fetching a user's profile

401

Unauthorized

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/account/ HTTP/1.1
Host: api.orchdio.dev
x-orchdio-key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

The response returned looks like:

// Some code
{
   "data":{
      "email":"[e-mail]",
      "id":"fd02e2ea-6f4c-11ed-aa88-abcd1390359d",
      "spotify":{
         "platform":"spotify",
         "username":"nerodrome",
         "profile_picture":"https://i.scdn.co/image/ab6775700000ee85e9082e13744a16dbcacdee66",
         "followers":1,
         "platform_id":"5ypdedejfiew8j9vmblxsfbd0",
         "platform_subscription_plan":"premium",
         "url":"https://open.spotify.com/user/5ypdedejfiew8j9vmblxsfbd0"
      }
   },
   "message":"Request Ok",
   "status":200
}