# Customer Index Endpoint

## Structure

See [View Customer Endpoint](https://support.aerocommerce.com/books/api/page/view-customer-endpoint) for the structure of the customer payload inside the `data` array.

## Filters

<table border="1" id="bkmrk-name-description-exa" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Description**  
</td><td>**Example**  
</td></tr><tr><td>`emails`</td><td>Only return customers with specific emails</td><td>`?emails=test@gmail.com,example@gmail.com`</td></tr><tr><td>`names`</td><td>Only return customers with specific names</td><td>`?names=Test,Another Test`</td></tr><tr><td>`groups`</td><td>Only return customers with specific groups</td><td>`?groups=VIP,Retail`</td></tr></tbody></table>

## Example Request

```
GET /api/customers?per_page=2
```

## Example Response

```json
{
    "current_page": 1,
    "data": [
        //...
    ],
    "first_page_url": "http://aero.test/api/customers?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://aero.test/api/customers?page=1",
    "next_page_url": null,
    "path": "http://aero.test/api/customers",
    "per_page": 2,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
```

<p class="callout info">See [View Customer Endpoint](https://support.aerocommerce.com/books/api/page/view-customer-endpoint) for the structure of the customer payload inside the `data` array.</p>