---
title: "Get customers"
method: GET
path: "/v3/customer"
---

# Get customers

`GET /v3/customer`

Get a list of customers

## Query parameters

- `merchantId` string, required
- `limit` integer
- `ascending` boolean
- `filter` string
- `spendProfile` string
- `sortField` string
- `lastActivity` string
- `startDate` string, date
- `endDate` string, date

## Response `200`

200

- object
  - `records` object[]
    - `id` integer
    - `name` string
    - `firstName` string
    - `lastName` string
    - `number` string
    - `email` string
    - `lastActivity` string
    - `allowPromotions` boolean
    - `spendProfile` string
    - `spendProfileIcon` string
    - `customerType` string
    - `isTaxExempt` boolean
    - `displayColor` string
    - `activeStatus` boolean
  - `recordCount` integer

## Other responses

- `400` — 400

---

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