Count products

Get the total count of products matching the specified criteria.

Access Control:

• Requires admin permissions

Important Notes:

• Counts can be filtered by keyword, active status, and deleted status
• Product feature must be enabled in network settings

GET /api/v1/products/count

Count products

cURL

curl --request GET \
  --url https://apix.us.amity.co/api/v1/products/count \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "data": {
    "count": 42
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

keyword · string

Search keyword for product name

Maximum string length: 200

isActive · boolean

Filter by active status

isDeleted · boolean

Filter by deleted status

Response

200

application/json

Successful response with product count

status · string

Example:

"success"

data · object

Show child attributes