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

# List customers

`GET /customers`

## Request

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

Your end customers, newest first. Cursor paginated. Requires `partner:read`.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

A page of customers

- object
  - `success` boolean
  - `data` PartnerCustomerList
    - `customers` PartnerCustomer[]
      - `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
    - `nextCursor` string, nullable: Pass back as `cursor` for the next page; null on the last page

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