Customer Index Endpoint

Structure

See View Customer Endpoint for the structure of the customer payload inside the data array.

Filters

Name	Description	Example
`emails`	Only return customers with specific emails	`?emails=test@gmail.com,example@gmail.com`
`names`	Only return customers with specific names	`?names=Test,Another Test`
`groups`	Only return customers with specific groups	`?groups=VIP,Retail`

Example Request

GET /api/customers?per_page=2

Example Response

{
    "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
}

See View Customer Endpoint for the structure of the customer payload inside the data array.