---
title: "List customers"
method: GET
path: "/3.0/ecommerce/stores/{store_id}/customers"
tags: ["ecommerce"]
---

# List customers

`GET /3.0/ecommerce/stores/{store_id}/customers`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/ecommerce/stores/{store_id}/customers`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/ecommerce/stores/:store_id/customers/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about a store's customers.

## Path parameters

- `store_id` string, required

## Query parameters

- `fields` string[]
- `exclude_fields` string[]
- `count` integer
- `offset` integer
- `email_address` string

## Response `200`

- object: A collection of the store's customers.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `customers` object[]: An array of objects, each representing a customer of a store.
    - `_links` object[]: A list of link types and descriptions for the API schema documents.
      - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
      - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
      - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
    - `address` object: The customer's address.
      - `address1` string: The mailing address of the customer.
      - `address2` string: An additional field for the customer's mailing address.
      - `city` string: The city the customer is located in.
      - `country` string: The customer's country.
      - `country_code` string: The two-letter code for the customer's country.
      - `postal_code` string: The customer's postal or zip code.
      - `province` string: The customer's state name or normalized province.
      - `province_code` string: The two-letter code for the customer's province or state.
    - `company` string: The customer's company.
    - `created_at` string, date-time: The date and time the customer was created in ISO 8601 format.
    - `email_address` string: The customer's email address.
    - `first_name` string: The customer's first name.
    - `id` string: A unique identifier for the customer.
    - `last_name` string: The customer's last name.
    - `opt_in_status` boolean: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers).
    - `orders_count` integer: The customer's total order count.
    - `sms_phone_number` string: A US phone number for SMS contact.
    - `total_spent` union
      - number
      - string
    - `updated_at` string, date-time: The date and time the customer was last updated in ISO 8601 format.
  - `store_id` string: The store id.
  - `total_items` integer: The total number of items matching the query regardless of pagination.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)