GET v1/store/login/user

Gets the currently logged-in user, who is identified by the provided security token.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns information about a user that is currently logged-in to the store.

UserModel
NameDescriptionTypeAdditional information
ID

The unique ID of the user.

 globally unique identifier

None.
FriendlyID

The friendly ID of the user.

 integer

None.
FirstName

The user's first name.

 string

None.
LastName

The user's last name.

 string

None.
Email

The user's email address.

 string

None.
ExternalID

The ID of the user in an external application.

 string

None.
Roles

The user's role(s) in the store.

 UserRolesModel

None.
Groups

The list of user groups to which the user belongs.

 Collection of UserGroupModel

None.
PhoneNumber

The user's phone number.

 string

None.
MobileNumber

The user's mobile number.

 string

None.
FaxNumber

The user's fax number.

 string

None.
CompanyName

The user's company name.

 string

None.
Department

The user's department.

 string

None.
JobTitle

The user's job title.

 string

None.
Gender

The user's gender.

 GenderType

None.
Birthday

The user's birthday.

 date

None.
CustomProperties

The user's custom properties.

 Collection of CustomUserPropertyModel

None.
IsAnonymous

Indicates whether the user is anonymous.

 boolean

None.
Preferences

User's preferences for UI based on the store.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": "250387cf-4401-44a5-976d-25ebb7b98b64",
  "FriendlyID": 2,
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Email": "sample string 5",
  "ExternalID": "sample string 6",
  "Roles": {
    "Shopper": true,
    "Approver": true
  },
  "Groups": [
    {
      "Name": "sample string 1"
    },
    {
      "Name": "sample string 1"
    }
  ],
  "PhoneNumber": "sample string 7",
  "MobileNumber": "sample string 8",
  "FaxNumber": "sample string 9",
  "CompanyName": "sample string 10",
  "Department": "sample string 11",
  "JobTitle": "sample string 12",
  "Gender": 1,
  "Birthday": "2025-12-17T07:33:01.0755534+00:00",
  "CustomProperties": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "IsAnonymous": true,
  "Preferences": "sample string 14"
}