BigCommerce Docs

query ExampleQuery($companyId: Int) {
  accountSettings(companyId: $companyId) {
    firstName
    lastName
    company
    phoneNumber
    email
    formFields {
      name
      value
    }
    role
    extraFields {
      fieldName
      fieldValue
    }
    companyRoleId
    companyRoleName
  }
}

{
  "companyId": 0
}

{
  "data": {
    "accountSettings": {
      "firstName": "example",
      "lastName": "example",
      "company": "example",
      "phoneNumber": "example",
      "email": "example",
      "formFields": [
        {
          "name": "example",
          "value": "GenericScalar"
        }
      ],
      "role": 0,
      "extraFields": [
        {
          "fieldName": "example",
          "fieldValue": "example"
        }
      ],
      "companyRoleId": 0,
      "companyRoleName": "example"
    }
  }
}

Details of account settings. Requires a B2B Token.

Arguments

companyIdIntegerRequired

The id of the company. This field is required

Returns

an optional AccountSettingType

firstNameString

User first name

lastNameString

User last name

companyString

Company for user

phoneNumberString

User phone number

emailString

User email

formFieldslist of optional FormFieldsType

List of address form fields

roleInteger

User role. Required. 0 - Admin, 1 - Senior Buyer, 2 - Junior Buyer

extraFieldslist of optional UserExtraFieldsValueType

extra fields of this user

companyRoleIdInteger

Company user role id

companyRoleNameString

Company user role name

1	query ExampleQuery($companyId: Int) {
2	accountSettings(companyId: $companyId) {
3	firstName
4	lastName
5	company
6	phoneNumber
7	email
8	formFields {
9	name
10	value
11	}
12	role
13	extraFields {
14	fieldName
15	fieldValue
16	}
17	companyRoleId
18	companyRoleName
19	}
20	}

1	{
2	"data": {
3	"accountSettings": {
4	"firstName": "example",
5	"lastName": "example",
6	"company": "example",
7	"phoneNumber": "example",
8	"email": "example",
9	"formFields": [
10	{
11	"name": "example",
12	"value": "GenericScalar"
13	}
14	],
15	"role": 0,
16	"extraFields": [
17	{
18	"fieldName": "example",
19	"fieldValue": "example"
20	}
21	],
22	"companyRoleId": 0,
23	"companyRoleName": "example"
24	}
25	}
26	}