get
https://{subdomain}.myshoplaza.com/openapi/2025-06/customers/count
Retrieve the total number of customers.
Requiresread_customeraccess scope.
The Get Customer Count API allows developers retrieve the total number of customers in the shop.
This API is especially useful for:
- Getting the total count of customers in a shop.
- Displaying customer metrics on dashboards or reports.
- Verifying the number of customers in bulk operations.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all queries are applied to the correct store.
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the response |
message | string | Descriptive message of the response | |
data.count | integer | 4 | Total number of customers. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |