# Customer List

### Method and URL

<mark style="color:green;">`GET`</mark> | <mark style="color:orange;">`[BASE_URL]`</mark>`/open-api/api/v1.0/customers`

### Query Options

<table data-full-width="true"><thead><tr><th width="168">Parameter</th><th width="250">Description</th><th>Example Value</th></tr></thead><tbody><tr><td>page</td><td>designated page</td><td>1</td></tr><tr><td>perPage</td><td>amount of record per page</td><td>10</td></tr><tr><td>phoneNumber</td><td>customer phone number</td><td>084288811166</td></tr></tbody></table>

### Response

#### **Response Body**

{% code fullWidth="true" %}

```json
{
    "code": "string",
    "message": "string",
    "data": [
        {
            "uuid": "234f-873g-551A-lgtm",
            "firstName":"John",
            "lastName":"Doe",
            "email": "johndoe@gmail.com",
            "phoneNumber":"081234567890",
            "merchantId": "7822-9dfu-2156-lgtm",
            "address": {
                "addressLine1": "addressLine1",
                "addressLine2": "addressLine2",
                "city": "Jakarta Utara",
                "state" : "DKI Jakarta",
                "postalCode": "123456", 
                "country": "ID"
            },
            "metadata": {
                "foo": "bar"
            }  
        },
        // more records...
    ],
    "pagination": {
        "page": "1",
        "perPage": "10",
        "totalPage": "5",
        "totalData": "50"
    }
}
```

{% endcode %}

#### **Response Data Schema**

<table data-full-width="true"><thead><tr><th width="176">Data Path</th><th width="339">Description</th><th width="246">Data Validation</th></tr></thead><tbody><tr><td>uuid</td><td>Unique Identifier</td><td>String</td></tr><tr><td>code</td><td>Response code</td><td>String</td></tr><tr><td>message</td><td>Response description</td><td>String</td></tr><tr><td>data</td><td>List of <a href="../customer-object-deprecated#customer-object-example">customer object</a></td><td>Array of Object</td></tr><tr><td>pagination</td><td>Pagination Information of the request</td><td>Object</td></tr></tbody></table>
