Skip to content
StraventaDocs
Now in Sandbox.

List customers for a merchant

Returns a paginated, searchable list of customer records belonging to the given merchant. Env-scoped — sandbox rows never appear in production listings.

GET
/v1/payments/merchants/{id}/customers

Returns a paginated, searchable list of customer records belonging to the given merchant. Env-scoped — sandbox rows never appear in production listings.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Merchant UUID

Formatuuid

Query Parameters

sort?string

Column to order the WHOLE customer directory by (server-side, across every page), not just the rows on the current page. Defaults to created_at descending. email, phone and address are deliberately not sortable — ordering acts as a comparison oracle over unmasked customer PII — and return 400 invalid_sort_key, as do the tenant/merchant UUIDs and deleted_at.

Value in"name" | "created_at" | "updated_at"
order?string

Sort direction. Any other value returns 400 invalid_sort_order.

Value in"asc" | "desc"
search?string

Free-text search across name, email, and phone

page?integer
Default1
Range1 <= value
limit?integer
Default25
Range1 <= value <= 100

Response Body

application/json

curl -X GET "https://example.com/v1/payments/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/customers"
{
  "customers": [],
  "total": 0,
  "page": 1,
  "limit": 25,
  "total_pages": 1
}
Empty
Empty

Was this page helpful?