List Subscribers

GET

https://api.bigcommerce.com/stores/:store_hash/v3/customers/subscribers

GET

/stores/:store_hash/v3/customers/subscribers

curl -G https://api.bigcommerce.com/stores/store_hash/v3/customers/subscribers \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -d id=1

{
  "data": [
    {
      "channel_id": 1,
      "consents": [
        "marketing_newsletter"
      ],
      "date_created": "2024-01-15T09:30:00Z",
      "date_modified": "2024-01-15T09:30:00Z",
      "email": "string",
      "first_name": "string",
      "id": 1,
      "last_name": "string",
      "order_id": 1,
      "source": "string"
    }
  ],
  "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"
      }
    }
  }
}

Returns a list of Subscribers. Optional filter parameters can be passed in.

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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

emailstringOptional

Filter items by email.

first_namestringOptional

Filter items by first_name.

last_namestringOptional

Filter items by last_name.

sourcestringOptional

Filter items by source.

order_idintegerOptional

Filter items by order_id.

date_createddatetimeOptional

Filter items by date_created.

date_created:mindatetimeOptional

Filter items by minimum date created, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields created after this date.

date_created:maxdatetimeOptional

Filter items by maximum date created, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields created before this date.

date_modifieddatetimeOptional

Filter items by date_modified. For example v3/catalog/products?date_last_imported:min=2018-06-15

date_modified:mindatetimeOptional

Filter items by minimum date modified, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields modified after this date.

date_modified:maxdatetimeOptional

Filter items by maximum date modified, for example, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields modified before this date.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

sortenumOptional

Field to sort by. Defaults to id.

directionenumOptional

Sort direction. Defaults to asc.

Allowed values:

idintegerRequired

Filter items by ID.

id:inlist of integersOptional

Filter items by ID. id:in=4,5,6

Response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error