Customers

Get a customer by query

Changed on Nov 3, 2026

Retrieves a customer by reference ID or email.

get/v1/customers

Request

Base URL
https://api.breeze.cash
Auth
HTTP basic
TypeScript
https://skmtc.dev/breeze/apis/breeze-api/docs/v1/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

referenceIdstring

emailstring email

Response

Success

status'SUCCEEDED' required

Changes

Nov 3, 20264af083d182a6 Revision changes
- info
  added the optional property / to the response with the status

Operation history