---
title: "Get a list of customers in CSV format"
method: GET
path: "/v3/merchants/{mId}/customers.csv"
tags: ["CUSTOMERS"]
---

# Get a list of customers in CSV format

`GET /v3/merchants/{mId}/customers.csv`

Gives information for every customer of a merchant by default.

## Path parameters

- `mId` string, required

## Query parameters

- `filter` string
- `expand` string

## Headers

- `User-Agent` string, required

## Response `200`

- object
  - `id` string — Unique identifier.
  - `merchant` object — Merchant associated with this customer.
    - `id` string — Unique identifier.
  - `firstName` string — First/given name of the customer. Note: Length of first name cannot be more than 64 characters.
  - `lastName` string — Last name/surname of the customer. Note: Length of last name cannot be more than 64 characters.
  - `marketingAllowed` boolean — Indicates if the customer allows receiving of marketing communication.
  - `customerSince` integer — Date of start of customer association with the merchant.
  - `orders` object[] — Customer's orders.
    - `id` string — Unique identifier.
  - `addresses` object[] — Customer's address. Note: Address cannot be null and should not be more than 127 characters long.
    - `address1` string — Customer's address, line one.
    - `address2` string — Customer's address, line two.
    - `address3` string — Customer's address, line three.
    - `city` string — Customer's city.
    - `country` string — Customer's country.
    - `state` string — Customer's state.
    - `zip` string — Postal code of the customer's address.
  - `emailAddresses` object[] — Customer's email address.
    - `id` string — Email identifier of the customer.
    - `emailAddress` string, required — Email address of the customer. Note: A valid email address is required. . Email address domains are validated using the [Apache Domain Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/DomainValidator.html). . Customer email addresses are validated using the [Apache Email Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/EmailValidator.html).
    - `verifiedTime` integer — Time when the customer's email address was verified as valid.
    - `primaryEmail` boolean — Customer's primary email address.
    - `customer` object — Name of the customer who provided the email address.
      - `id` string — Unique identifier.
  - `phoneNumbers` object[] — Customer's phone numbers.
    - `id` string — Phone number identifier.
    - `phoneNumber` string, required — Customer's phone number.
    - `customer` object — Customer name associated with the phone number.
      - `id` string — Unique identifier.
  - `cards` object[] — Customer's card details.
    - `id` string — Card identifier.
    - `first6` string, required — First 6 digits of the customer's card.
    - `last4` string, required — last 4 digits of the customer's card.
    - `firstName` string — First name on the customer's card.
    - `lastName` string — Last name on the customer's card.
    - `expirationDate` string — Expiry date of the customer's card.
    - `additionalInfo` object — Additional information for the customer's card.
      - `default` string
    - `cardType` string — Customer's card type.
    - `token` string — Customer's card token number. Note: Token length cannot be more than 72 characters.
    - `tokenType` 'MULTIPAY' | 'FINANCIAL' | 'CTOKEN' — Customer's card token type.
    - `modifiedTime` integer — Time when the card was last updated.
    - `customer` object — Customer who this card belongs to.
      - `id` string — Unique identifier.
  - `metadata` object — Additional information about the customer.
    - `businessName` string — Name of customer's business. Note: Length of the business name cannot be more than 127 characters.
    - `note` string — Additional information about the customer. Note: Length of the note cannot be more than 2000 characters.
    - `dobYear` integer — Optional. Year of the customer’s date of birth.
    - `dobMonth` integer — Month of the customer’s date of birth.
    - `dobDay` integer — Day of the customer’s date of birth.
    - `modifiedTime` integer — Time when the customer data was last updated.
    - `customer` object — Customer for whom the metadata is saved.
      - `id` string — Unique identifier.

---

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