Get user

curl --request GET \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}"

headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-site-context': '<x-site-context>', Authorization: 'Bearer <token>'}
};

fetch('https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": [
    {
      "address1": "1234 Main St.",
      "city": "Houston",
      "state": "TX",
      "country": "USA",
      "zipCode": 77035,
      "email": "test@mail.com",
      "isValidated": true,
      "isDefault": true,
      "attention": "Account Manager",
      "address2": "Suite 710",
      "address3": "Floor 7",
      "company": "Acme Inc.",
      "kind": "Business",
      "phone": {
        "number": "555-123-4567",
        "kind": "Mobile"
      },
      "name": {
        "first": "Pat",
        "last": "Kake"
      }
    }
  ],
  "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"
}

{
  "error": "USER_NOT_FOUND",
  "code": "404",
  "message": "User not found"
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "code": "500",
  "message": "Internal server error"
}

GET

api-commerceIdentity

user

{userId}

Get user

curl --request GET \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}"

headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-site-context': '<x-site-context>', Authorization: 'Bearer <token>'}
};

fetch('https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{customerDomain}.fabric.zone/api-commerceIdentity/user/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": [
    {
      "address1": "1234 Main St.",
      "city": "Houston",
      "state": "TX",
      "country": "USA",
      "zipCode": 77035,
      "email": "test@mail.com",
      "isValidated": true,
      "isDefault": true,
      "attention": "Account Manager",
      "address2": "Suite 710",
      "address3": "Floor 7",
      "company": "Acme Inc.",
      "kind": "Business",
      "phone": {
        "number": "555-123-4567",
        "kind": "Mobile"
      },
      "name": {
        "first": "Pat",
        "last": "Kake"
      }
    }
  ],
  "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"
}

{
  "error": "USER_NOT_FOUND",
  "code": "404",
  "message": "User not found"
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "code": "500",
  "message": "Internal server error"
}

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

User

isActive

boolean

true: User is active
false: User is not active

Example:

true

registrationDate

string<date-time>

Time user was registered

Example:

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

expiryDate

string<date-time>

Time user's registration expires

Example:

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

roles

string[]

User roles

Example:

"customer"

name

object

User's full name

Show child attributes

phone

object[]

User's telephone numbers and details

Show child attributes

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

Show child attributes

provider

object[]

Additional user details

Show child attributes

createdAt

string<date-time>

Time user was created

Example:

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

updatedAt

string<date-time>

Time user was last updated

Example:

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

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get user

Authorizations

Headers

Path Parameters

Response