---
title: "List Customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# List Customers

`GET /v1/customers`

## Request

- Base URL: `//mapi.boomfi.xyz` (relative, and the document’s source URL is not known)
- URL: `//mapi.boomfi.xyz/v1/customers`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/boomfi/apis/boomfi-merchants-api/docs/v1/customers/get.ts> (a function with typed inputs; its response is checked against the schema)

The **List Customers** endpoint allows you to retrieve a paginated list of customers associated with your organization. This endpoint provides optional parameters for sorting and filtering the results, enabling you to manage and review customer data efficiently.

## Query parameters

- `limit` integer
- `page` integer
- `search` string
- `type` 'first-time' | 'repeat'

## Response `200`

OK

- InternalPaginatedResponseCustomersResponseCustomer
  - `data` InternalPaginatedItemsCustomersResponseCustomer
    - `items` CustomersResponseCustomer[]
      - `created_at` string: The timestamp indicating when the customer record was created.
      - `customer_ident` string: The unique identifier for the customer.
      - `email` string: The email address associated with the customer.
      - `guest` boolean: Indicates whether the customer is a guest (true) or not (false).
      - `id` string: The unique identifier for the customer.
      - `is_deleted` boolean: Indicates whether the customer has been deleted (true) or not (false).
      - `last_payment_date` string: The timestamp indicating the date of the last payment made by the customer.
      - `metadata` object: Additional metadata associated with the customer.
      - `name` string: The name of the customer.
      - `organisation_id` string: The identifier of the organization to which the customer belongs.
      - `payments_count` integer: The total count of payments made by the customer.
      - `phone` string: The phone number associated with the customer.
      - `properties` object: Additional custom properties associated with the customer.
      - `updated_at` string: The timestamp indicating when the customer record was last updated.
      - `wallet_address` string: The wallet address associated with the customer for cryptocurrency transactions.
    - `last_update` string: The timestamp indicating when the data was last updated.
    - `next` integer: The index indicating the next page of items.
    - `total` integer: The total number of items across all pages.
  - `error` boolean

---

[API](https://skmtc.dev/boomfi/apis/boomfi-merchants-api.md) - [All operations](https://skmtc.dev/boomfi/apis/boomfi-merchants-api/llms.txt) - [OpenAPI document](https://skmtc.dev/boomfi/apis/boomfi-merchants-api/revisions/ace3c3df05fe?raw)