---
title: "Get a customer with health"
method: GET
path: "/customers/{id}"
tags: ["Partners"]
---

# Get a customer with health

`GET /customers/{id}`

## Request

- Base URL: `https://faivelo.com/api/partner`
- URL: `https://faivelo.com/api/partner/customers/{id}`
- Auth: HTTP bearer

One customer with its sending health: status, who set any sending lock, its own 30-day bounce and complaint rates, per-domain reputation, and the sending tenant's state. Requires `partner:read`.

## Path parameters

- `id` string, required

## Response `200`

The customer and its health

- object
  - `success` boolean
  - `data` PartnerCustomerHealth: An end customer you resell to
    - `id` string
    - `email` string
    - `name` string, nullable
    - `companyName` string, nullable
    - `status` 'active' | 'paused' | 'suspended'
    - `plan` 'STARTER' | 'GROWTH' | 'PRO' | 'BUSINESS': The highest plan among the customer's domains (a summary: billing is per domain), and the plan its next domain takes by default
    - `relayCeiling` 'trial' | 'standard': `trial` until the account earns the standard sending ceiling on clean history
    - `domains` integer
    - `mailboxes` integer
    - `sandbox` boolean: Created in test mode: never provisioned, billed or emailed, erased after 30 days
    - `createdAt` string, date-time
    - `suspendedReason` string, nullable
    - `sendPausedAt` string, date-time, nullable
    - `sendPauseCount` integer: Times sending has been paused on this account
    - `lockedBy` 'partner' | 'faivelo' | 'null', nullable: Who set the current sending lock: you, a Faivelo abuse control, or nobody
    - `cleanSendCount` integer: Sends counted towards graduating from the trial ceiling
    - `domainList` object[]
      - `domain` string
      - `verified` boolean
      - `enforcementTier` string
      - `bounceRate` number: Fraction of sends, e.g. 0.012 is 1.2%
      - `complaintRate` number: Fraction of sends, e.g. 0.012 is 1.2%
      - `mailboxes` integer
      - `storage` StorageSummary, nullable: Bytes used and allowed. Null when the mail server could not answer.
        - `usedBytes` integer
        - `limitBytes` integer, nullable
        - `availableBytes` integer, nullable
      - `storageLimitBytes` integer, nullable
    - `storage` StorageSummary, nullable: Bytes used and allowed. Null when the mail server could not answer.
      - `usedBytes` integer
      - `limitBytes` integer, nullable
      - `availableBytes` integer, nullable
    - `rates` PartnerCustomerRates: The customer's own sending numbers over the last 30 days
      - `sends` integer
      - `bounces` integer
      - `complaints` integer
      - `bounceRate` number: Fraction of sends, e.g. 0.012 is 1.2%
      - `complaintRate` number: Fraction of sends, e.g. 0.012 is 1.2%
      - `offender` boolean: Over the pause threshold on its own numbers (once it has sent enough to be judged)
    - `reputation` PartnerTenantReputation, nullable: State of the customer's isolated sending tenant. Null before the customer's first send.
      - `tenantName` string
      - `sending` 'enabled' | 'disabled' | 'reinstated' | 'unknown': Whether mail can leave this tenant right now
      - `customerManaged` 'enabled' | 'disabled' | 'reinstated' | 'unknown': Faivelo's own switch on the tenant (pauses and locks)
      - `awsManaged` 'enabled' | 'disabled' | 'reinstated' | 'unknown': The mail provider's switch, driven by reputation policy
      - `awsCause` string, nullable
      - `impact` string, nullable: Highest active reputation finding against the tenant, if any
      - `managed` boolean: Whether containment (the reputation policy) is attached

## Other responses

- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `429`: Rate limit exceeded

---

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