List Customers — GET /customers

Returns a paginated list of your customers, newest first. A customer is created automatically the first time an email pays you; order_count and total_spent stay in sync as payments settle. Requires the customers:read scope.

Request

GET https://api.blockra.io/customers

Query parameters

page

integer

default:"1"

Page number (1-based).

limit

integer

default:"25"

Items per page (max 100).

sort

string

Sort column: id, email, order_count, total_spent, or created_at.

order

string

default:"desc"

asc or desc.

filter_id

string

Exact customer ID.

filter_email

string

Substring match on the customer email.

order_count_min

integer

Minimum number of settled payments.

order_count_max

integer

Maximum number of settled payments.

total_spent_min

number

Minimum lifetime spend (net fiat).

total_spent_max

number

Maximum lifetime spend (net fiat).

start_date

string

ISO date — created on or after.

end_date

string

ISO date — created before.

Response

items

array

The customers on this page.

total

integer

Total matching customers.

page

integer

Current page.

limit

integer

Page size.

total_pages

integer

Total number of pages.

curl "https://api.blockra.io/customers?limit=10&sort=total_spent&order=desc" \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": {
    "items": [
      {
        "id": "cus_9z8y7x6w5v4u3t2s1r0q",
        "email": "buyer@example.com",
        "name": null,
        "order_count": 4,
        "total_spent": 312.40,
        "created_at": "2026-06-02T09:14:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10,
    "total_pages": 1
  },
  "error": null
}

​Request

​Query parameters

​Response

Request

Query parameters

Response