---
title: "Get All Customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# Get All Customers

`GET /customers`

Returns a list of Customers. Optional filter parameters can be passed in.
**Notes**
Attribute names are not available on the customer object.

## Query parameters

- `page` integer
- `limit` number
- `id:in` integer[]
- `company:in` string[]
- `customer_group_id:in` string[]
- `date_created` string, date-time
- `date_created:max` string
- `date_created:min` string, date-time
- `date_modified` string, date-time
- `date_modified:min` string
- `date_modified:max` string, date-time
- `email:in` string
- `name:in` string[]
- `name:like` string[]
- `registration_ip_address:in` integer[]
- `include` 'addresses' | 'storecredit' | 'attributes' | 'formfields'
- `sort` 'date_created:asc' | 'date_created:desc' | 'last_name:asc' | 'last_name:desc'

## Response `200`

OK

- CustomerCollectionResponse — Customer Collection Response
  - `data` Customer[]
    - `email` string — The email of the customer. Must be unique.
    - `first_name` string — The first name of the customer.
    - `last_name` string — The last name of the customer.
    - `company` string — The company of the customer.
    - `phone` string — The phone number of the customer.
    - `registration_ip_address` string — The IP address from which this customer was registered.
    - `notes` string — The customer notes.
    - `tax_exempt_category` string — The tax exempt category code for the customer.
    - `customer_group_id` integer — Id of the group which this customer belongs to.
    - `id` integer — The unique numeric ID of the customer.
    - `date_modified` string, date-time — The date on which the customer was modified.
    - `date_created` string, date-time — The date of which the customer was created.
    - `address_count` integer — Total number of customer addresses
    - `attribute_count` integer — Total number of customer attributes
    - `authentication` object
      - `force_password_reset` boolean — If `true`, this customer will be forced to change password on next login.
    - `addresses` object[] — Array of customer addresses. Limited to 10
      - `first_name` string, required — The first name of the customer address.
      - `last_name` string, required — The last name of the customer address.
      - `company` string — The company of the customer address.
      - `address1` string, required — The address 1 line.
      - `address2` string — The address 2 line.
      - `city` string, required — The city of the customer address.
      - `state_or_province` string, required — The state or province name
      - `postal_code` string, required — The postal code of the customer address.
      - `country_code` string, required — The country code of the customer address.
      - `phone` string — The phone number of the customer address.
      - `address_type` 'residential' | 'commercial' — The address type. Residential or Commercial
      - `customer_id` integer, required — The customer ID.
      - `id` integer, required — The unique numeric ID of the address.
      - `country` string — The country name of the customer address.
      - `form_fields` object[] — Array of form fields. Controlled by `formfields` parameter.
    - `attributes` object[] — Array of customer attributes. Limited to 10
      - `attribute_id` integer, required — Attribute ID.
      - `value` string, required — Attribute value. This will always be a string, regardless of the attributes type.
      - `id` integer — Attribute value ID.
      - `customer_id` integer, required — Customer ID.
      - `date_modified` string, date-time — The date on which the customer attribute value was modified.
      - `date_created` string, date-time — The date of which the customer attribute value was created.
    - `form_fields` object[] — Array of form fields. Controlled by `formfields` parameter.
    - `store_credit_amounts` object[] — Store credit.
      - `amount` number, float
    - `accepts_product_review_abandoned_cart_emails` boolean — It determines if the customer is signed up to receive either product review or abandoned cart emails or recieve both emails.
    - `channel_ids` integer[] — Array of channel ids the Customer has access to.
  - `meta` CollectionMeta — Data about the response, including pagination and collection totals.
    - `pagination` Pagination — Data about the response, including pagination and collection totals.
      - `total` integer — Total number of items in the result set.
      - `count` integer — Total number of items in the collection response.
      - `per_page` integer — The amount of items returned in the collection per page, controlled by the limit parameter.
      - `current_page` integer — The page you are currently on within the collection.
      - `total_pages` integer — The total number of pages in the collection.
      - `links` object — Pagination links for the previous and next parts of the whole collection.
        - `previous` string — Link to the previous page returned in the response.
        - `current` string — Link to the current page returned in the response.
        - `next` string — Link to the next page returned in the response.

---

[API](https://skmtc.net/bigcommerce/apis/bigcommerce-api.md) · [All operations](https://skmtc.net/bigcommerce/apis/bigcommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigcommerce/bigcommerce-api/versions/90efb67b99f3/schema)