---
title: "Get a customer by query"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# Get a customer by query

`GET /v1/customers`

Retrieves a customer by reference ID or email.

## Query parameters

- `referenceId` string
- `email` string, email

## Response `200`

Success

- object — The matching customer
  - `status` 'SUCCEEDED', required
  - `data` GetCustomerByQueryResponse, required
    - `id` string, required
    - `referenceId` string, required
    - `email` string
    - `merchantId` string, required
    - `livemode` boolean, required
    - `signupAt` number, required
    - `supportedPaymentMethods` string[]
    - `supportedPayoutMethods` string[]
    - `firstName` string
    - `middleName` string
    - `lastName` string
    - `dateOfBirth` string
    - `phoneNumber` string
    - `address` object
      - `line1` string
      - `line2` string
      - `city` string
      - `state` string
      - `postalCode` string
      - `country` string

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/breeze/breeze-api/revisions/8911892bdf29/schema)