Get User Details

GET

https://api-b2b.bigcommerce.com/api/v3/io/users/:userId

GET

/api/v3/io/users/:userId

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

{
  "code": 200,
  "data": {
    "id": 1,
    "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"
      }
    ],
    "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"
      }
    ]
  },
  "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

codeintegerOptionalDefaults to 200

Operation status code.

dataobjectOptional

metaobjectOptional

Errors

404

Not Found Error