Salla Docs
List Customers
GET/customersThis endpoint lets you list all customers associated with your store and filter them using a keyword. It retrieves customers whose "mobile number", "email", or "name" match the keyword you provide.
:::info[]
The rate limit for the customers endpoints is 500 request per 10 minutes. For more details, please visit the Rate Limiting & change log documentation page.
:::
Request
The Pagination page number
Fetch a list of customers created before a specific date
Fetch a list of customers created after a specific date
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
A unique identifier for the customer.
The customer's first name.
The customer's last name.
The customer's mobile phone number without the country code.
The country code for the customer's mobile phone number.
The customer's email address.
A list of URLs associated with the customer, such as their website or social media profiles.
A URL to the customer's avatar image.
The customer's gender.
The city where the customer lives.
The country where the customer lives.
The country code for the customer's country.
The currency that the customer uses.
The customer's location, represented as a string.
The date and time when the customer's information was last updated.
A list of group IDs that the customer belongs to.
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"status": 200,
"success": true,
"data": [
{
"id": 2075683582,
"first_name": "Ahmed",
"last_name": "Ali",
"mobile": 777777777,
"mobile_code": "967",
"email": "[email protected]",
"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": "السعودية",
"location": "null",
"updated_at": {
"date": "2020-04-02 22:43:26.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"groups": [
11323141,
11323142
]
},
{
"id": 2075683581,
"first_name": "Ali",
"last_name": "Ahmed",
"mobile": 777777777,
"mobile_code": "967",
"email": "[email protected]",
"avatar": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
"gender": "male",
"city": "Riyadh",
"country": "السعودية",
"location": "null",
"updated_at": {
"date": "2020-04-02 22:43:26.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"groups": [
11323141,
11323142
]
}
],
"pagination": {
"count": 2,
"total": 2,
"perPage": 15,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}