GET
/
api-commerceIdentity
/
user
/
{userId}
curl --request GET \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "isActive": true,
  "registrationDate": "2020-04-15T10:08:04.246Z",
  "expiryDate": "2020-04-15T10:08:04.246Z",
  "roles": "customer",
  "name": {
    "first": "Pat",
    "middle": "E",
    "last": "Kake"
  },
  "phone": [
    {
      "number": "555-123-4567",
      "countryCode": "+91",
      "extenstion": "x-6789",
      "kind": "Mobile"
    }
  ],
  "email": "test@mail.com",
  "extra": {},
  "registrationSite": "XXX",
  "account": "xxxxxcxxxxxxxxxxxxxx",
  "userId": "6169b2d892a5f30009d76480",
  "address": [
    {
      "attention": "Account Manager",
      "address1": "1234 Main St.",
      "address2": "Suite 710",
      "address3": "Floor 7",
      "city": "Houston",
      "state": "TX",
      "country": "USA",
      "zipCode": 77035,
      "company": "Acme Inc.",
      "kind": "Business",
      "phone": {
        "number": "555-123-4567",
        "kind": "Mobile"
      },
      "name": {
        "first": "Pat",
        "last": "Kake"
      },
      "email": "test@mail.com",
      "isValidated": true,
      "isDefault": true
    }
  ],
  "provider": [
    {
      "id": "6228f647a257734d91dbb49f",
      "name": "LOCAL",
      "isActive": true,
      "registrationDate": "2020-04-15T10:08:04.246Z",
      "lastLoginDate": "2020-04-15T10:08:04.246Z"
    }
  ],
  "createdAt": "2020-04-15T10:08:04.246Z",
  "updatedAt": "2020-04-15T10:08:04.246Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
userId
string
required

User ID

Example:

"6169b2d892a5f30009d76480"

Response

200
application/json
OK

User

​
isActive
boolean

true: User is active<br />false: User is not active

Example:

true

​
registrationDate
string

Time user was registered

Example:

"2020-04-15T10:08:04.246Z"

​
expiryDate
string

Time user's registration expires

Example:

"2020-04-15T10:08:04.246Z"

​
roles
string[]

User roles

Example:

"customer"

​
name
object

User's full name

​
phone
object[]

User's telephone numbers and details

​
email
string

User's email address

Example:

"test@mail.com"

​
extra
object

Extra user details

​
registrationSite
string

XXX

Example:

"XXX"

​
account
string

Merchant account ID

Example:

"xxxxxcxxxxxxxxxxxxxx"

​
userId
string

User ID

Example:

"6169b2d892a5f30009d76480"

​
address
object[]

User address

Address

​
provider
object[]

Additional user details

Object to store personal details

​
createdAt
string

Time user was created

Example:

"2020-04-15T10:08:04.246Z"

​
updatedAt
string

Time user was last updated

Example:

"2020-04-15T10:08:04.246Z"

Was this page helpful?