Skip to main content
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

integer
default:"1"
Page number (1-based).
integer
default:"25"
Items per page (max 100).
string
Sort column: id, email, order_count, total_spent, or created_at.
string
default:"desc"
asc or desc.
string
Exact customer ID.
string
Substring match on the customer email.
integer
Minimum number of settled payments.
integer
Maximum number of settled payments.
number
Minimum lifetime spend (net fiat).
number
Maximum lifetime spend (net fiat).
string
ISO date — created on or after.
string
ISO date — created before.

Response

array
The customers on this page.
integer
Total matching customers.
integer
Current page.
integer
Page size.
integer
Total number of pages.