Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

List Customers

GET

https://api.zid.sa/v1/managers/store/customers

This endpoint will return a list of the store customers along with other metadata such as the total number of customers and the total number of orders for each customer.

🔑Scopes

customers.read - Customers Read

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/store/customers?page=1&per_page=50' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "string",
    "customers": [
        {
            "id": 0,
            "name": "string",
            "email": "string",
            "mobile": "string",
            "gender": "string",
            "birth_date": "string",
            "verified": true,
            "is_active": true,
            "is_cod_enabled": true,
            "type": "string",
            "business_name": "string",
            "tax_number": null,
            "commercial_registration": "string",
            "source": null,
            "points": 0,
            "order_total_payments": "string",
            "last_order_date": "string",
            "created_at": "string",
            "updated_at": "string",
            "city": {
                "id": 0,
                "national_id": 0,
                "name": "string",
                "priority": 0,
                "country_id": 0,
                "country_name": "string",
                "country_code": "string",
                "ar_name": "string",
                "en_name": "string"
            },
            "nickname": "string",
            "pivotEmail": "string",
            "pivotMobile": "string",
            "order_counts": 0
        }
    ],
    "grand_total": 0,
    "total_customers_count": 0,
    "active_customers_count": 0,
    "inactive_customers_count": 0,
    "message": {
        "type": "object",
        "code": "string",
        "name": "string",
        "description": "string"
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-01-30 20:55:20

Customers

Retrieve Customer