List Customer Groups | BigCommerce Developer Center

Returns a list of Customer Groups. Default sorting is by customer-group ID, from lowest to highest.

Note: The default rate limit for this endpoint is 40 concurrent requests.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_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.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Customers | modify | `store_v2_customers` | | Customers | read-only | `store_v2_customers_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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

pagedoubleOptional

Number of pages.

limitdoubleOptional

Count per page.

namestringOptional

Filter customer groups by exact name match.

name:likestringOptional

Filter customer groups by name, using a fuzzy matching method.

is_defaultbooleanOptional

Filter by customers who sign up are added to this group by default.

date_createddatetimeOptional

Filter customer groups by date_created. date_created=2018-09-05T13:43:54

date_created:maxstringOptional

Filter customer groups by maximum date_created. date_created:max=2018-09-10

date_created:mindatetimeOptional

Filter customer groups by date_created. date_created:min=2018-09-05

date_modifieddatetimeOptional

Filter customer groups by date_modified. date_modified=2018-09-05T13:45:03

date_modified:mindatetimeOptional

Filter customer groups by minimum date_modified. date_modified:min=2019-09-04T:00:00:00 or date_modified:min=2019-09-04

date_modified:maxdatetimeOptional

Filter customer groups by maximum date_modified. date_modified:max=2018-09-05T13:45:03 or date_modified:max=2019-09-04

is_group_for_guestsbooleanOptional

Filter whether the group is for guests. There can only be one customer group for guests at a time.

Response

idinteger

ID of the customer group.

namestring

Name of the group.

is_defaultboolean

Determines whether new customers are assigned to this group by default.

category_accessobject

discount_ruleslist of objects

date_createdstring

Date on which the customer group was created.

date_modifiedstring

Date on which the customer group was last modified.

is_group_for_guestsboolean

Describes whether the group is for guests. There can only be one customer group for guests at a time.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/customer_groups"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	[
2	{
3	"id": 1,
4	"name": "Wholesale",
5	"is_default": false,
6	"category_access": {
7	"type": "all",
8	"categories": [
9	18,
10	19,
11	23,
12	34
13	]
14	},
15	"discount_rules": [
16	{
17	"type": "price_list",
18	"method": "percent",
19	"amount": "5.0000",
20	"price_list_id": 3
21	}
22	],
23	"date_created": "2023-07-17 06:30:41",
24	"date_modified": "2023-07-25 01:15:19",
25	"is_group_for_guests": true
26	}
27	]