---
title: "List customers"
description: "List customers Filemonk has delivered to, newest first, paginated (page, per_page up to 200), each with how many orders they have. search matches email, phone or name; email matches exactly; unsubscribed=true narrows to "
url: https://docs.filemonk.io/v2/api-reference/customers/list-customers/
api: "API v2 reference"
method: GET
path: "/customers"
---

# List customers

`GET https://app.filemonk.io/api/v2/external/customers`

List customers Filemonk has delivered to, newest first, paginated (page, per_page up to 200), each with how many orders they have. search matches email, phone or name; email matches exactly; unsubscribed=true narrows to buyers who opted out of the merchant's emails.

## Query parameters

- `unsubscribed` (string) One of: `true`, `false`.
- `page` (integer): 1-based page number.
- `per_page` (integer): Rows per page, max 200.
- `search` (string)
- `email` (string)

## Returns

- `data` (array of objects, required)
  - `id` (string, nullable, required): e.g. `ca5b4abc-63b1-4e29-be0a-12acb35908c5`
  - `shopify_customer_id` (string, nullable, required): e.g. `gid://shopify/Customer/10296813191463`
  - `email` (any, required)
  - `phone` (any, required)
  - `first_name` (string, nullable, required): e.g. `Jane`
  - `last_name` (string, nullable, required): e.g. `Doe`
  - `orders_count` (integer, nullable, required): e.g. `1`
  - `marketing` (object, required)
    - `unsubscribed` (boolean, nullable, required): e.g. `false`
    - `unsubscribed_at` (any, required)
  - `created_at` (string, nullable, required): e.g. `2026-10-26T14:19:29Z`
  - `updated_at` (string, nullable, required): e.g. `2026-10-26T14:19:29Z`
- `meta` (object, required): Paging of a list (`page`, `per_page` query params).
  - `total_count` (integer, required): Rows across all pages.
  - `page` (integer, required): 1-based page number.
  - `per_page` (integer, required): Rows per page, max 200.
  - `total_pages` (integer, required): e.g. `1`

Rate limit: this call costs 1 point ([rate limits](https://docs.filemonk.io/v2/errors-and-rate-limits/)).

## Examples

### List customers

```sh
curl "https://app.filemonk.io/api/v2/external/customers" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"
```

### List customers filtered by unsubscribed and email

```sh
curl "https://app.filemonk.io/api/v2/external/customers?unsubscribed=true&email=shopper%40example.com" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"
```

## 200

Success: one page of rows.

```json
{
  "data": [
    {
      "id": "ca5b4abc-63b1-4e29-be0a-12acb35908c5",
      "shopify_customer_id": "gid://shopify/Customer/10296813191463",
      "email": null,
      "phone": null,
      "first_name": "Jane",
      "last_name": "Doe",
      "orders_count": 1,
      "marketing": {
        "unsubscribed": false,
        "unsubscribed_at": null
      },
      "created_at": "2026-10-26T14:19:29Z",
      "updated_at": "2026-10-26T14:19:29Z"
    }
  ],
  "meta": {
    "total_count": 8,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}
```

## 401

Missing or invalid API key.

```json
{
  "errors": [
    "Invalid API key"
  ]
}
```

## 422

The request failed validation, or sent a key the action does not take (`code: "unknown_parameters"` with `unknown` and `accepted`). Nothing was saved.

```json
{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}
```

## 429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` (Unix time the window ends); a 429 adds `Retry-After` (seconds), `retry_after`, `retryable: true` and a `next_step` in the body. A 429 did nothing: wait `retry_after` seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with `per_page` over many single reads.

```json
{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}
```