Skip to navigation
RESTAdminManagementCustomersV3Consent

Get Customer Consent

Gets the status of a customerʼs consent to allow data collection by cookies and scripts while shopping on a storefront.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Customersmodifystore_v2_customers
Customersread-onlystore_v2_customers_read_only
Stored Payment Instrumentsmodifystore_stored_payment_instruments
Stored Payment Instrumentsread-onlystore_stored_payment_instruments_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

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.

Path parameters

customerIdintegerRequired
The ID of the customer.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Response

The customer's consent settings.
allowlist of enumsOptional
Allowed values:
denylist of enumsOptional
Allowed values:
updated_atdatetimeOptional

The date of which the customer consent was last updated.

NOTE

Currently, this field returns the time of the current API Call, not the time of last update. For PUT requests, this is typically accurate; however, it will not be accurate for GET requests.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error