Welcome to Albato Help

Method for getting a user profile


IN THIS ARTICLE

This method lets you get the parameters of your existing (previously created) user.

Authorization: This method should be called with the partner's master account token.

Request:

POST https://api.albato.com/wl/partner-name/get-user-profile?expand=transactions

Where partner-name is your company name (partner name) in Albato.

Request parameters:

  • id — An alphanumeric user ID that the partner passes when creating a new user. In most cases, this is the user’s nickname, the part of the email address before @your-domain (for example, john.smith from john.smith@your-domain). Use the same value consistently and insert it into the id field.

Response parameters:

  • success — Request success indicator. Available values: true or false
  • data.id — An existing user's ID (in Albato)
  • data.email — An existing user's email
  • data.language — An existing user's interface language
  • data.timezoneOffset — An existing user's time zone
  • data.planId – An existing user's plan ID; returned only if billing plans are enabled
  • data.trxLimit – Remaining user transaction limit; returned only if billing plans are enabled

Request example via curl:

curl --header "Content-type: application/json"
--header "Accept: application/json"
--header "Authorization: Basic cEFJjGffUSkV6WFFyWUhBM1RzS2hRHg7iKgReghUiijBfrdTY6"
--request POST
--data '{"id":"test"}'
"https://api.albato.com/wl/partner-name/get-user-profile?expand=transactions"

Response example:

{ "success": true, "data": { "id": 1357, "email": "test@example.com", "language": "pt", "timezoneOffset": -180 } }

Did this answer your question?