Get User Details by BigCommerce Customer ID

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

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

Returns detailed information for the user associated with customerId. Analogous to Get User Details. If the B2B Edition customer account associated with customerId has been deleted, this will return a 404 error.

Returns detailed information for the user associated with `customerId`. Analogous to [Get User Details](#get-user-details). If the B2B Edition customer account associated with `customerId` has been deleted, this will return a `404` error.

Authentication

X-Auth-Tokenstring

Authentication header

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

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

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

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

Path parameters

customerIdstringRequired

Response

Success

codeintegerDefaults to 200

Operation status code.

dataobject

metaobject

Errors

404

Not Found Error