Skip to content

Get User

Request URL

GET /user

Description

Get a complete user record for the currently logged in user. No request body or path parameters are necessary for this endpoint, as the current context will be sufficient.

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'GET',
  url: '${AMPLIFI_BASE_URL}/user',
  headers: {
    'token': "A long random string token received from /token request"
  },
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "AMPLIFI_BASE_URL/user"  --header "token: A long random string token received from /token request" 

Successful Response Examples

200 USER SUCCESSFUL RESPONSE GET USER DETAILS

HEADERS

Header Value
token A long random string token received from /token request

REQUEST BODY

none

RESPONSE BODY

{
    "AFiUserId": "qweaurl8kgtlv9pc",
    "dtsCreated": "2022-09-27T17:21:23.445Z",
    "names": [],
    "name": {
        "firstName": "John",
        "middleName": "",
        "lastName": "Testman"
    },
    "firstName": "John",
    "sortId": "s7j",
    "languageCode": "en",
    "dtsModified": "2023-03-10T17:59:52.933Z",
    "dtsCreatedAtUsers": "2022-09-27T17:21:23.445Z",
    "segment": "demo",
    "postOnboardingStepsRequired": null,
    "referralCode": "BBBUTHZFE",
    "extras": {
        "sex": "male",
        "eyeColor": "BRO",
        "hairColor": "BLK",
        "heightMetric": "181",
        "weightMetric": "85"
    },
    "private": true,
    "isFullyRegistered": true,
    "isIdleUser": false,
    "uiStage": "firstContact",
    "middleName": "",
    "lastName": "Testman",
    "ssn": "316642992",
    "dosDob": "1978-10-15",
    "dobDay": "15",
    "dobMonth": "10",
    "dobYear": "1978",
    "addresses": [
        {
            "addressLine1": "123 Main Str.",
            "addressLine2": null,
            "city": "Harrisburg",
            "state": "PA",
            "postalCode": "12345",
            "countryCode": "US",
            "AFiUserId": "qweaurl8kgtlv9pc",
            "dtsRecorded": "2022-09-27T17:21:57.953Z",
            "AFiUserAddressId": "qwebeteysxkycnkcyddoziktasubadowcprrvwjsjri",
            "dtsModified": "2022-09-27T17:21:57.953Z"
        },
        {
            "AFiUserAddressId": "qweawual8kgtlv9pclf2uet6vk7xak7j28betkrtm0d9k",
            "addressLine1": "123 Main Str.",
            "city": "Harrisburg",
            "state": "PA",
            "countryCode": "US",
            "postalCode": "12345",
            "dtsModified": "1978-10-15T04:00:00.000Z",
            "isMain": false,
            "AFiUserId": "qweaurl8kgtlv9pc",
            "dtsRecorded": "2023-03-10T17:59:52.917Z"
        }
    ],
    "mobile": "1234567890",
    "email": "test@sample.com",
    "homecurrency": "USD",
    "isActive": true,
    "dtsRegistered": "2022-09-27T17:21:57.913Z",
    "phoneNumbers": [
        "4345156001"
    ],
    "emails": [
        "aa@aa.ae",
        "test@sample.com"
    ],
    "isMetric": false,
    "faceImage": "a+very+long+string",
    "mainAFiAccountId": "qwegal8kgtmysmels",
    "isEmailConfirmed": false,
    "isMobilePhoneConfirmed": false
}