Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Request

HTTP request

GET /v2/accounts/{accountId}/users/{userId}/profile

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Responses

CodeDescriptionReference
200

Successful response.

UserProfiles
400

Error encountered.

errorDetails

SDK Method

Users::getProfile

Definitions

addressInformation_v2
authenticationMethod
errorDetails
forgottenPasswordInformation
group
nameValue
settingsMetadata
usageHistory
userAccountManagementGranularInformation
userInfo
UserProfiles
Users

Examples

Generic JSON Response
Generic XML Response