List Customer Metafields

GET

https://api.bigcommerce.com/stores/:store_hash/v3/customers/:customerId/metafields

GET

/stores/:store_hash/v3/customers/:customerId/metafields

curl https://api.bigcommerce.com/stores/store_hash/v3/customers/1/metafields \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "app_only",
      "value": "4HG",
      "date_created": "2018-05-07T20:14:17+00:00",
      "date_modified": "2018-05-07T20:14:17+00:00",
      "description": "Location in the warehouse",
      "id": 6,
      "resource_id": 111,
      "resource_type": "customer"
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Gets customer metafields by passing the customerId in the query parameters.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

customerIdintegerRequired

The ID of the customer.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

Response payload for the BigCommerce API.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Response