List Customers

GET

https://api.techrar.com/public-api/v1/customers/

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.

Permission

customer.read - customers read only

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.techrar.com/public-api/v1/customers/' \
--header 'app-id: 4' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "country_code": "966",
            "username": "0534501056",
            "mobile_number": "966534501056",
            "email": "[email protected]",
            "name": "Safwan Saigh",
            "lang": "en",
            "current_city_id": 1,
            "is_email_verified": true,
            "is_mobile_verified": true,
            "is_blocked": false,
            "is_deleted": false,
            "is_verified": true,
            "national_id": "1111782031",
            "secondary_mobile_number": "0534501056",
            "date_of_birth": "1999-02-25",
            "avatar": "/media/uploads/customer/avatars/2024/07/29/12048986-a1b6-4e1d-9b8a-216331f3cd71.png",
            "joined_at": "2022-03-12 14:51:15.115924+00:00",
            "custom_fields": null
        },
        {
            "id": 35218,
            "country_code": "966",
            "username": "0552800186",
            "mobile_number": "966552800186",
            "email": "[email protected]",
            "name": "The one",
            "lang": "ar",
            "current_city_id": null,
            "is_email_verified": false,
            "is_mobile_verified": true,
            "is_blocked": false,
            "is_deleted": false,
            "is_verified": true,
            "national_id": null,
            "secondary_mobile_number": null,
            "date_of_birth": null,
            "avatar": null,
            "joined_at": "2025-02-19 12:03:06.864872+00:00",
            "custom_fields": null
        },
        {
            "id": 35262,
            "country_code": "966",
            "username": "0552800187",
            "mobile_number": "966552800187",
            "email": "[email protected]",
            "name": "The one",
            "lang": "ar",
            "current_city_id": null,
            "is_email_verified": false,
            "is_mobile_verified": true,
            "is_blocked": false,
            "is_deleted": false,
            "is_verified": true,
            "national_id": null,
            "secondary_mobile_number": null,
            "date_of_birth": null,
            "avatar": null,
            "joined_at": "2025-05-04 16:59:42.037478+00:00",
            "custom_fields": null
        }
    ]
}

Modified at 2025-10-20 10:05:32

Customer Order Statistics

Customer Details