API ReferenceCustomers
List customers
GET /rest/v1/customers
Buyers with order count, total spent (canceled/refunded excluded) and channels. Page-based.
Required scope: orders:read.
Authorization
apiKey AuthorizationBearer <token>
Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.
In: header
Query Parameters
search?string
channel?string
repeat?string
returning = 2+ orders.
sort?string
Default last_order_at. Anything else answers 422.
Value in
- "last_order_at"
- "total_spent"
- "orders_count"
- "name"
dir?string
Value in
- "asc"
- "desc"
page?integer
Range
1 <= valuelimit?integer
Range
1 <= value <= 100Response Body
application/json
application/json
curl -X GET "https://example.com/customers"{ "object": "list", "data": [ { "object": "customer", "email": "string", "first_name": "string", "last_name": "string", "phone": "string", "city": "string", "country": "string", "orders_count": 0, "total_spent": "129.80", "currency": "string", "first_order_at": "2019-08-24T14:15:22Z", "last_order_at": "2019-08-24T14:15:22Z", "channels": [ "string" ] } ], "page": 0, "total": 0, "contacts_masked": true}Last updated on October 18, 2026
Need help?
Email us and a human replies, usually within one business day.