userEmailCheck | BigCommerce Developer Center

query ExampleQuery($email: String, $companyId: Int, $storeHash: String, $channelId: Int) {
  userEmailCheck(email: $email, companyId: $companyId, storeHash: $storeHash, channelId: $channelId) {
    userType
    userInfo {
      id
      email
      firstName
      lastName
      phoneNumber
      role
      companyName
      originChannelId
      forcePasswordReset
    }
  }
}

{
  "email": "example",
  "companyId": 0,
  "storeHash": "",
  "channelId": 0
}

{
  "data": {
    "userEmailCheck": {
      "userType": 0,
      "userInfo": {
        "id": 0,
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "phoneNumber": "example",
        "role": 0,
        "companyName": "example",
        "originChannelId": 0,
        "forcePasswordReset": true
      }
    }
  }
}

Check if a user email exists in B2B or BC, supports multi-storefront.
Requires a B2B Token.

Arguments

emailStringRequired

User email to verify. This field is required.

companyIdIntegerOptional

The id of the company.

storeHashStringOptional

The store hash.

channelIdIntegerOptional

BC channel id.

Returns

an optional Object

userTypeInteger

1: not exist; 2: exist in BC; 3: exist more than one in BC; 4: exist in B3 other company; 5: exist in B3 current company; 6: exist in B3 as super admin; 7: exist in B3 current company other channel;

userInfoObject