List customers

Return customers visible to the authenticated account or product-scoped key.

Last updated

Author: AtomicPay API

Authentication

Send your AtomicPay developer API key using Authorization: Bearer <API_KEY> or X-API-Key: <API_KEY>. This endpoint requires customers.read permission, unless the key has wildcard access (*).

Query parameters

limit

Optional. Defaults to 20 and is capped at 100.

email

Optional. Exact customer email filter.

GET/v1/customers

Base URL: https://api.atomicpay.com.br

Return customers visible to the authenticated account or product-scoped key.

Request examples

curl

curl "https://api.atomicpay.com.br/v1/customers?limit=20" \
  -H "Authorization: Bearer {{api_key}}"

request.js

const response = await fetch('https://api.atomicpay.com.br/v1/customers?limit=20', {
  method: 'GET',
  headers: { Authorization: 'Bearer {{api_key}}' },
});

const data = await response.json();

Response

response.json

{
  "object": "list",
  "data": [
    {
      "id": "cus_123",
      "object": "customer",
      "name": "Jenny Rosen",
      "email": "jenny@example.com",
      "created_at": 1766400000000
    }
  ],
  "has_more": false,
  "total_count": 1
}

Retrieve a purchase

Retrieve one purchase by ID, scoped to the authenticated account or product.

Retrieve a customer