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

# List customers

`GET /customers`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/customers`
- Auth: API key in header `Authorization`

Returns a list of customers for the current account

## Query parameters

- `customer_type` 'lead' | 'free' | 'paid'
- `query` string
- `deleted` boolean
- `starting_after` string
- `limit` integer
- `metadata` object

## Response `200`

List of customers

- ListResponseCustomer
  - `object` 'list', required
  - `data` Customer[], required
    - `id` string, required
    - `object` string, required
    - `email` string, required
    - `name` string, nullable, required
    - `first_name` string, nullable, required
    - `last_name` string, nullable, required
    - `phone_number` string, nullable, required
    - `customer_type` 'paid' | 'free' | 'lead', required
    - `notes` string, nullable, required
    - `confirmed_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `deleted_at` string, date-time, nullable, required
    - `purge_at` string, nullable, required
    - `anonymized` boolean, required
    - `metadata` object, required
    - `orders_count` integer, required
    - `total_spend` number, required
    - `tags` unknown[], required
      - unknown
  - `has_more` boolean, required
  - `url` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)