Skip to main content

Get Customers List

By calling this API, you can get the list of customers in the specified outlet.

GET /integrations/mokapos/outlets/{outlet_id}/v1/customers

Path Parameters

AttributeDescriptionTypeRequired
outlet_idThe Outlet IDStringRequired

Query Parameters

AttributeDescriptionTypeRequired
per_pageThe max number of items on each page. Max: 1000IntegerOptional
pageThe number of the pageIntegerOptional

Sample Response - 200 Success

{
"success": true,
"data": {
"total_pages": 4,
"total_count": 4,
"customers": [
{
"id": 4504270,
"name": "Peter Parker",
"phone": "+6281234567890",
"email": "[email protected]",
"address": "Teluk Gong",
"city": "Jakarta",
"state": "Jakarta",
"postal_code": "14450",
"created_at": "2021-11-26T17:40:54.932000+07:00",
"updated_at": "2021-12-03T18:08:10.165000+07:00"
}
]
}
}
note

To perform this operation, you must be authenticated using go_auth_client_credentials(mokapos:reporting:read).