v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Customers

List Customers

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.

get/v1/customers

Query parameters

limitinteger

The number of items to be included in each page of the API response.

pageinteger

The page number of the results to be retrieved.

searchstring

The search query or keyword that filters the results returned by the API.

type'first-time' | 'repeat'

Specifies a type or category for filtering the results.

Response

errorboolean

Example response

{
  "data": {
    "items": [
      {
        "created_at": "2023-03-15T08:30:00Z",
        "customer_ident": "CUST123",
        "email": "example@email.com",
        "id": "123456789",
        "last_payment_date": "2023-03-20T12:00:00Z",
        "name": "John Doe",
        "organisation_id": "ORG123",
        "payments_count": 5,
        "updated_at": "2023-03-25T10:45:00Z",
        "wallet_address": "0x4bbeEB066eD09B7AEd07bF39EEe0460DFa261520"
      }
    ],
    "last_update": "2021-01-01T00:00:00Z",
    "next": 10,
    "total": 10
  }
}