---
title: "list customers"
method: GET
path: "/api/v1/sales/customers"
tags: ["orders"]
---

# list customers

`GET /api/v1/sales/customers`

## Request

- Base URL: `https://api.app.tightly.io`
- URL: `https://api.app.tightly.io/api/v1/sales/customers`
- Auth: HTTP bearer

Everyone the record knows, from a connected channel or from an order somebody typed. Deliberately thin: a display name, the email's domain, a country and a coarsened region, and never a street address, a phone number or an email in the clear. Do not call this to build a marketing list, and do not call it to find one person you already have the id for: `GET /sales/customers/{customer_id}` serves that one with their orders and returns.

Scope: `orders:read`.

## Query parameters

- `trading_partner_id` string
- `search` string
- `offset` integer
- `limit` integer

## Headers

- `Tightly-Version` string

## Response `200`

The page of customers, and how many the filter matched in all.

- object
  - `data` object: rows, offset, size, filtered_max_size, and `withheld_words`, which reads `Not held` on a tenant that never holds a person and null on one that may.
  - `message` object: severity, service and desc.

## Other responses

- `400`: `offset` or `limit` is outside the range the list offers.
- `401`: No usable key: malformed, unknown, revoked, expired or stopped.
- `403`: The key does not hold Orders (`scope_missing`), or is issued to one account and named another (`account_mismatch`).
- `429`: The key has spent its allowance for this minute. 600 reads and 120 writes a minute, counted per key, refused calls included. `Retry-After` says how long to wait.
- `503`: The database is briefly out of reach, which is what a failover or a full connection pool looks like from outside. Wait the seconds `Retry-After` names and send the request again. A read is safe to repeat. A write is not, because the connection was lost in the middle of it, so read the object back before sending it a second time. Branch on the status rather than on `code`, which is `POSTGRES_UNAVAILABLE` from one of the two seams that raise this and `SERVICE_UNAVAILABLE` from the other.

---

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