---
title: "Preview customer retention"
method: GET
path: "/customers/retention_preview"
tags: ["Customers"]
---

# Preview customer retention

`GET /customers/retention_preview`

## Request

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

Shows what a retention period would delete: leads (customers without an account) with no form submission, booking, call, checkout or 1:1 email in the last `days` days. Broadcasts don't count as contact. Leads with orders are kept and counted in `exempt_count`. Customers with an account are never deleted by retention. Set the period with `customer_retention_days` on `PATCH /v1/account`; a daily job then deletes matching leads, and they are permanently erased `purge_after_days` later.

## Query parameters

- `days` integer

## Response `200`

Retention preview

- object
  - `object` 'customer_retention_preview', required
  - `days` integer, nullable, required: The period previewed; null when none was given and the account has none set.
  - `deletable_count` integer, required
  - `exempt_count` integer, required: Inactive leads kept because they have paid orders.
  - `purge_after_days` integer, required
  - `sample` Customer[], required: Up to 20 of the leads that would be deleted, oldest first.
    - `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

## 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)