orders

list customers

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.

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

Query parameters

trading_partner_idstring

Only this account's own customer record.

searchstring

A term containing an @ is read as an email address and matched against its pseudonym, exactly. Anything else matches the display name or the email's domain.

offsetinteger

How many customers to skip. The list is ordered by the most recent order, newest first.

limitinteger

How many customers to return, at most 100.

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

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

dataobject

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.

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.