BigCommerce Docs

query ExampleQuery($storeHash: String, $email: String, $customerId: Int) {
  companyUserInfo(storeHash: $storeHash, email: $email, customerId: $customerId) {
    userType
    userInfo {
      id
      firstName
      lastName
      phoneNumber
      role
      companyRoleId
      companyRoleName
      email
      forcePasswordReset
    }
  }
}

{
  "storeHash": "example",
  "email": "example",
  "customerId": 0
}

{
  "data": {
    "companyUserInfo": {
      "userType": 0,
      "userInfo": {
        "id": 0,
        "firstName": "example",
        "lastName": "example",
        "phoneNumber": "example",
        "role": 0,
        "companyRoleId": 0,
        "companyRoleName": "example",
        "email": "example",
        "forcePasswordReset": true
      }
    }
  }
}

This API is deprecated, use 'userEmailCheck' instead. Get the information of a user. Doesn't require a Token.

Arguments

storeHashStringRequired

The Store Hash. This field is required.

emailStringRequired

Email address of the user. This field is required.

customerIdIntegerOptional

BC customer id

Returns

an optional CompanyUserInfoType

userTypeInteger

The user type of current email. 1 means user does't exist. 2 means the user exists in BigCommerce. 3 means the user exists in BundleB2B.

userInfoCompanyEmailUserInfoType

1	query ExampleQuery($storeHash: String, $email: String, $customerId: Int) {
2	companyUserInfo(storeHash: $storeHash, email: $email, customerId: $customerId) {
3	userType
4	userInfo {
5	id
6	firstName
7	lastName
8	phoneNumber
9	role
10	companyRoleId
11	companyRoleName
12	email
13	forcePasswordReset
14	}
15	}
16	}

1	{
2	"storeHash": "example",
3	"email": "example",
4	"customerId": 0
5	}

1	{
2	"data": {
3	"companyUserInfo": {
4	"userType": 0,
5	"userInfo": {
6	"id": 0,
7	"firstName": "example",
8	"lastName": "example",
9	"phoneNumber": "example",
10	"role": 0,
11	"companyRoleId": 0,
12	"companyRoleName": "example",
13	"email": "example",
14	"forcePasswordReset": true
15	}
16	}
17	}
18	}