Customer List

Get a Collection of Customer

Method and URL

GET | [BASE_URL]/open-api/api/v1.0/customers

Query Options

Parameter	Description	Example Value
page	designated page	1
perPage	amount of record per page	10
phoneNumber	customer phone number	084288811166

Response

Response Body

{
    "code": "string",
    "message": "string",
    "data": [
        {
            "uuid": "234f-873g-551A-lgtm",
            "firstName":"John",
            "lastName":"Doe",
            "email": "[e-mail]",
            "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"
    }
}

Response Data Schema

Data Path	Description	Data Validation
uuid	Unique Identifier	String
code	Response code	String
message	Response description	String
data	List of customer object	Array of Object
pagination	Pagination Information of the request	Object