List Customers
GET {{baseUrl}}/customers
You can list all customers related to your store directly from this endpoint. Also, it allows you to filter them using a keyword, the endpoint would retrieve any customer matches this keyword in their data whether in their mobile number or email or name.
OAuth Scopes
customers.read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | The Pagination page number | |
keyword | string | The keyword in case you want to search in the customers. It Limits the list of customers to those who have the given string in their (Mobile - Name - Email) |
RESPONSES
status: OK
{"status":200,"success":true,"data":[{"id":2075683582,"first_name":"Ahmed","last_name":"Ali","mobile":8237647835734576000,"mobile_code":"999","email":"ahmedali@test.test","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiley"},"avatar":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","gender":"male","city":"Riyadh","country":"SA","location":"null","updated_at":{"date":"2020-04-02 22:43:26.000000","timezone_type":3,"timezone":"Asia/Riyadh"}},{"id":2075683581,"first_name":"Ali","last_name":"Ahmed","mobile":872367436576,"mobile_code":"999","email":"aliahmed@test.test","avatar":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","gender":"male","city":"Riyadh","country":"SA","location":"null","updated_at":{"date":"2020-04-02 22:43:26.000000","timezone_type":3,"timezone":"Asia/Riyadh"}}],"pagination":{"count":2,"total":2,"perPage":15,"currentPage":1,"totalPages":1,"links":[]}}