BigCommerce Docs

curl https://api-b2b.bigcommerce.com/api/v3/io/users/123 \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": {
    "id": 1,
    "companyId": 42,
    "createdAt": 1,
    "updatedAt": 1,
    "customerId": 12345,
    "companyRoleName": "Approver",
    "channelList": [
      {
        "channelId": 1,
        "channelName": "Default Storefront",
        "iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
      }
    ],
    "firstName": "Marie",
    "lastName": "Curie",
    "email": "john.doe@example.com",
    "phoneNumber": "+1-555-123-4567",
    "role": 1,
    "companyRoleId": 10,
    "uuid": "user-uuid-1",
    "extraFields": [
      {
        "fieldName": "customField1",
        "fieldValue": "value1"
      }
    ]
  },
  "meta": {
    "message": "Success"
  }
}

curl https://api-b2b.bigcommerce.com/api/v3/io/users/123 \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": {
    "id": 1,
    "companyId": 42,
    "createdAt": 1,
    "updatedAt": 1,
    "customerId": 12345,
    "companyRoleName": "Approver",
    "channelList": [
      {
        "channelId": 1,
        "channelName": "Default Storefront",
        "iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
      }
    ],
    "firstName": "Marie",
    "lastName": "Curie",
    "email": "john.doe@example.com",
    "phoneNumber": "+1-555-123-4567",
    "role": 1,
    "companyRoleId": 10,
    "uuid": "user-uuid-1",
    "extraFields": [
      {
        "fieldName": "customField1",
        "fieldValue": "value1"
      }
    ]
  },
  "meta": {
    "message": "Success"
  }
}

Returns detailed user information for the user specified by userId. Unlike Get All Users, this endpoint includes extra fields by default.

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

userIdintegerRequired

The unique identifier of the user as reported by Get All Users.

Response

Success

codeintegerDefaults to 200

Operation status code.

dataobject

metaobject

Errors

404

Not Found Error

Get User Details

Get User Details

Authentication

Path parameters

Response

Errors

Authentication

Path parameters

Response

Errors

$	curl https://api-b2b.bigcommerce.com/api/v3/io/users/123 \
>	-H "X-Auth-Token: <apiKey>"

1	{
2	"code": 200,
3	"data": {
4	"id": 1,
5	"companyId": 42,
6	"createdAt": 1,
7	"updatedAt": 1,
8	"customerId": 12345,
9	"companyRoleName": "Approver",
10	"channelList": [
11	{
12	"channelId": 1,
13	"channelName": "Default Storefront",
14	"iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
15	}
16	],
17	"firstName": "Marie",
18	"lastName": "Curie",
19	"email": "john.doe@example.com",
20	"phoneNumber": "+1-555-123-4567",
21	"role": 1,
22	"companyRoleId": 10,
23	"uuid": "user-uuid-1",
24	"extraFields": [
25	{
26	"fieldName": "customField1",
27	"fieldValue": "value1"
28	}
29	]
30	},
31	"meta": {
32	"message": "Success"
33	}
34	}