Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs
    Light Mode

    List Customers

    GET/customers
    Last modified: 16 days ago

    This 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.

    `customers.read`- Customers Read Only

    Request

    Query Params
    page
    integer 
    optional

    The Pagination page number

    Example:
    2
    keyword
    string 
    optional


    - customer.mobile | 966511804534
    - customer.name | Del John
    - shipping_number | Find a specific shipment by its ID from here
    - reference_id | 613398835
    - tag_name | Find a specific tag by its name from here

    Example:
    966511804534
    date_from
    string 
    optional

    Fetch a list of customers created before a specific date

    Example:
    2024-12-30
    date_to
    string 
    optional

    Fetch a list of customers created after a specific date

    Example:
    2024-12-31

    Request samples

    Responses

    Success(200)
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    No schema defined
    Example
    {
  "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": []
  }
}
    Last modified: 16 days ago