<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/customers/top-customers -->

# Get Top Customers

Retrieve top customers by transaction volume.

<EndpointHeader verb="GET" path="/merchant/api/v1/customers/top" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
  ]}
/>

### Query Parameters

<ParamTable
  rows={[
    { name: "limit", type: "integer", default: "10", desc: "Number of customers (max 100)" },
    { name: "startDate", type: "string", default: "-", desc: "Start date (ISO 8601)" },
    { name: "endDate", type: "string", default: "-", desc: "End date (ISO 8601)" },
    { name: "currency", type: "string", default: "-", desc: "Filter by currency" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": [
    {
      "customerId": "cust_a1b2c3d4e5f6g7h8",
      "email": "vip@example.com",
      "name": "Jane Smith",
      "lifetimeValue": 150000,
      "totalTransactions": 45
    },
    {
      "customerId": "cust_c3d4e5f6g7h8i9j0",
      "email": "john@example.com",
      "name": "John Doe",
      "lifetimeValue": 125000,
      "totalTransactions": 38
    }
  ],
  "message": "Top customers retrieved successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 150,
    "api_version": "v1",
    "endpoint": "GET /customers/top",
    "user_type": "merchant"
  }
}
```

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/customers/top?limit=20&currency=USD" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const topCustomers = await zenpays.customers.getTop({
  limit: 20,
  currency: 'USD',
});
```

  </TabItem>
</Tabs>

</CodeRail>
