Retrieve user's profile

Retrieve user's profile.

SecuritySecretApiKey or JWT
Responses
200

Profile retrieved.

Response Schema: application/json
id
string <= 50 characters

ID of the user.

email
string <email> <= 100 characters

Email address of the user.

firstName
string

User's first name.

lastName
string

User's last name.

businessPhone
string

User's business phone number.

mobilePhone
string

User's mobile phone number.

Array of objects (Membership)

Organization memberships.

Array
required
object

Organization membership.

required
object

Membership user.

allowedIps
Array of strings or null <ip> (AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

permissions
Array of strings <operationId>

Permissions that the user has within the organization. Use the wildcard character * for full access.

isOwner
boolean

Specifies whether the user is the owner of the organization.

isDefault
boolean

Specifies whether the organization is the default organization for the user.

roleIds
Array of strings

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

Array of objects (Self) non-empty

Related links.

availableCurrencies
Array of strings

Array of reporting currencies that are enabled for the merchant.

reportingCurrency
string

User's currency code in ISO 4217 format. This value is used for reports.

totpRequired
boolean
Deprecated

Specifies whether two-factor authentification is enabled for the user.

totpSecret
string
Deprecated

User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled.

totpUrl
string <url>
Deprecated

QR-code link that redirects the user to the authentification application, if TOTP is enabled.

oneTimePassword
string^[0-9]{6}$
Deprecated

One-time password generated by Google Authenticator. This value is required when enabling or disabling 2FA.

This field must use digits only.

country
string

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferences
object

User preferences, such as: timezone, language, and more. This is an object with custom properties.

hasPermissionsEmulation
boolean

Specifies whether the current user session has permissions emulation enabled.

displayName
string

User's full display name.

hash
string

Unique hash value that represents the user.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/profile
Request samples
const profile = await api.profile.get();
console.log(profile.fields.email);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "businessPhone": "string",
  • "mobilePhone": "string",
  • "memberships": [
    ],
  • "availableCurrencies": [
    ],
  • "reportingCurrency": "string",
  • "totpRequired": true,
  • "totpSecret": "string",
  • "totpUrl": "string",
  • "oneTimePassword": "123456",
  • "country": "string",
  • "preferences": { },
  • "hasPermissionsEmulation": true,
  • "displayName": "string",
  • "hash": "string"
}