List Customers

GET https://api.salla.dev/admin/v2/customers?page=1&keyword=<string>

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.

Request Params

KeyDatatypeRequiredDescription
pagenumberThe Pagination page number
keywordstring<br>- customer.mobile

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobile&quot;:&quot;\u003cnumber\u003e&quot;,&quot;mobile_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;urls&quot;:{&quot;customer&quot;:&quot;\u003cstring\u003e&quot;,&quot;admin&quot;:&quot;\u003cstring\u003e&quot;},&quot;avatar&quot;:&quot;\u003cstring\u003e&quot;,&quot;gender&quot;:&quot;\u003cstring\u003e&quot;,&quot;brithday&quot;:{&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone_type&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;},&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;country_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:{&quot;date&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;timezone_type&quot;:&quot;\u003cnumber\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;},&quot;groups&quot;:[&quot;\u003cinteger\u003e&quot;,&quot;\u003cinteger\u003e&quot;]}],&quot;pagination&quot;:{&quot;count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;perPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currentPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;totalPages&quot;:&quot;\u003cnumber\u003e&quot;,&quot;links&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}