Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

days
integer

Retention period to preview, 30 to 3650. Defaults to the account's customer_retention_days.

Required range: 30 <= x <= 3650

Response

Retention preview

object
enum<string>
required
Available options:
customer_retention_preview
days
integer | null
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
object[]
required

Up to 20 of the leads that would be deleted, oldest first.