List Customers

Retrieve a paginated list of customers for a given organisation, with optional sorting and filtering parameters

GET /customers

List Customers

cURL

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/customers \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "items": [
      {
        "created_at": "<string>",
        "customer_ident": "<string>",
        "email": "<string>",
        "guest": true,
        "id": "<string>",
        "is_deleted": true,
        "last_payment_date": "<string>",
        "metadata": {},
        "name": "<string>",
        "organisation_id": "<string>",
        "payments_count": 123,
        "phone": "<string>",
        "properties": {},
        "updated_at": "<string>",
        "wallet_address": "<string>"
      }
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

limit · integer

Page size. Defaults to 100. Minimum 1, maximum 100.

Required range: 1 <= x <= 100

page · integer

Page number (1-based). Defaults to 1.

Required range: x >= 1

search · string

Case-insensitive search over customer name, email, and reference.

since · string<date-time>

Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.

sort · enum<string>

Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.

Available options: asc, desc

type · enum<string>

Filter by customer visit type.

Available options: first-time, repeat

until · string<date-time>

Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.

Response

200 - application/json

OK

data · object

Paginated payload.

Show child attributes

error · boolean

True when the request failed.