List Extra Fields for Users

GET

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

GET

/api/v3/io/users/extra-fields

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

200Users_get_users_extra_fields_example

{
  "code": 200,
  "data": [
    {
      "id": 12,
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fieldName": "Customer Loyalty Number",
      "labelName": "Customer Loyalty Number",
      "fieldType": 0,
      "isRequired": false,
      "isUnique": true,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "N/A",
      "maximumLength": "20"
    },
    {
      "id": 15,
      "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fieldName": "Preferred Contact Method",
      "labelName": "Preferred Contact Method",
      "fieldType": 3,
      "isRequired": true,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 2,
      "defaultValue": "Email",
      "listOfValue": [
        "Email",
        "Phone",
        "SMS",
        "Postal Mail"
      ]
    },
    {
      "id": 18,
      "uuid": "9b2d7f3a-1c4e-4f3a-8f3a-2d7f3a1c4e4f",
      "fieldName": "Account Notes",
      "labelName": "Account Notes",
      "fieldType": 1,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": false,
      "configType": 2,
      "defaultValue": "",
      "numberOfRows": "5"
    },
    {
      "id": 21,
      "uuid": "d2719f3a-4e5f-4a3b-9f3a-1c4e2d7f3a1c",
      "fieldName": "Customer Rating",
      "labelName": "Customer Rating",
      "fieldType": 2,
      "isRequired": false,
      "isUnique": false,
      "visibleToEnduser": true,
      "configType": 1,
      "defaultValue": "3",
      "maximumValue": "5"
    }
  ],
  "meta": {
    "pagination": {
      "totalCount": 4,
      "limit": 10,
      "offset": 0
    },
    "message": "Success"
  }
}

Returns paginated list of extra field definitions for users.

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

offsetintegerOptional>=0Defaults to 0

The number of items to skip before starting to collect the result set.

limitintegerOptional1-250Defaults to 10

The maximum number of results to return.

Response

Success

codeintegerOptional

datalist of objectsOptional

metaobjectOptional