List Company Extra Field Configs

GET

https://api-b2b.bigcommerce.com/api/v3/io/companies/extra-fields

GET

/api/v3/io/companies/extra-fields

curl -G https://api-b2b.bigcommerce.com/api/v3/io/companies/extra-fields \
     -H "X-Auth-Token: <apiKey>" \
     -d limit=10 \
     -d offset=3

200Companies_get-companies-extra-fields_example

{
  "code": 200,
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "limit": 10,
      "offset": 0,
      "totalCount": 3
    }
  },
  "data": [
    {
      "id": 987654,
      "uuid": "a3f1c9e2-4b7d-4f8a-9c2e-1d2b3f4a5c6d",
      "fieldName": "Customer Tax Code",
      "labelName": "Customer Tax Code",
      "fieldType": 3,
      "isRequired": true,
      "isUnique": true,
      "visibleToEnduser": true,
      "configType": 1,
      "defaultValue": "Code G",
      "listOfValue": [
        "Retail",
        "Automotive",
        "Manufacturing"
      ]
    },
    {
      "id": 987655,
      "uuid": "b4d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
      "fieldName": "Preferred Contact Method",
      "labelName": "Preferred Contact Method",
      "fieldType": 3,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "Email",
      "listOfValue": [
        "Email",
        "Phone",
        "Fax"
      ]
    },
    {
      "id": 987656,
      "uuid": "c5e6f7a8-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
      "fieldName": "Annual Revenue",
      "labelName": "Annual Revenue",
      "fieldType": 2,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": false,
      "configType": 2,
      "defaultValue": "500000",
      "maximumValue": "10000000"
    }
  ]
}

Returns a list of available extra fields configs for Company accounts.

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.

Query parameters

limitintegerOptionalDefaults to 10

Determines the number of records to return per page. If left blank, this defaults to 10.

offsetintegerOptionalDefaults to 0

The number of results to skip before returning the first result. If left blank, this defaults to 0.

Response

codeintegerOptional

Response code of success request.

metaobjectOptional

Used to response pagination information

datalist of objectsOptional