For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
        • Checkouts
        • Currencies
          • V3
              • GETList Customers
              • POSTCreate Customers
              • PUTUpdate Customers
              • DELDelete Customers
                • GETGet Customer Settings per Channel
                • PUTUpdate Customer Settings per Channel
          • V2
        • Customer Segmentation
        • Geography
        • Infrastructure Hosting
        • Inventory
        • Orders
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminManagementCustomersV3Channel Settings

Get Customer Settings per Channel

GET
https://api.bigcommerce.com/stores/:store_hash/v3/customers/settings/channels/:channel_id
GET
/stores/:store_hash/v3/customers/settings/channels/:channel_id
$curl https://api.bigcommerce.com/stores/store_hash/v3/customers/settings/channels/1 \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json"
200data
1{
2  "privacy_settings": {
3    "ask_shopper_for_tracking_consent": true,
4    "policy_url": "https://www.bigcommerce.com/privacy-policy"
5  },
6  "customer_group_settings": {
7    "guest_customer_group_id": 5,
8    "default_customer_group_id": 10
9  },
10  "allow_global_logins": true
11}
Returns the customer settings per channel. **Notes:** * `null` value configuration indicates that there is no override provided for a given channel; thus, values are inherited from [Global Settings](/developer/api-reference/rest/admin/management/customers/v3/global-settings).
Was this page helpful?
Previous

Delete Customer Attributes

Next

Update Customer Settings per Channel

Built with

Returns the customer settings per channel.

Notes:

  • null value configuration indicates that there is no override provided for a given channel; thus, values are inherited from Global Settings.

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

channel_idintegerRequired
store_hashstringRequired
Permanent ID of the BigCommerce store.

Response

Customer settings for this channel are returned.
dataobject
metaobject