Skip to main content
GET
/
api
/
product
List Products
curl --request GET \
  --url https://api.example.com/api/product \
  --header 'x-api-key: <x-api-key>'
{
  "statusCode": 123,
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "variant": [
        {}
      ],
      "price": 123,
      "stock": 123,
      "category_id": 123,
      "category_name": "<string>",
      "category_slug": "<string>",
      "img_urls": [
        {}
      ],
      "created_at": "<string>"
    }
  ],
  "metadata": {
    "currentPage": 123,
    "totalPages": 123,
    "totalItems": 123,
    "itemsPerPage": 123,
    "category": {}
  }
}

​
Authentication

This endpoint requires an API key to be passed in the header.
​
x-api-key
string
required
Your API key for authentication

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"10"
Number of items per page
​
q
string
Search query to filter products by name or description
​
category
string
Category slug to filter products by category
​
sortBy
string
default:"name"
Column to sort by. Valid values: name, price, stock, created_at
​
order
string
default:"asc"
Sort order. Valid values: asc, desc

​
Response

​
statusCode
integer
HTTP status code (200 for success)
​
message
string
Response message
​
data
array
Array of product objects
​
metadata
object
Pagination metadata

​
Example Request

curl --request GET \
  --url 'https://api.example.com/api/product?page=1&limit=10&q=shirt&category=mens-clothing&sortBy=price&order=asc' \
  --header 'x-api-key: your_api_key_here'

​
Example Response

{
  "statusCode": 200,
  "message": "Success fetching products data",
  "data": [
    {
      "id": 1,
      "name": "Classic Cotton Shirt",
      "slug": "classic-cotton-shirt",
      "description": "A comfortable cotton shirt perfect for everyday wear",
      "variant": ["S", "M", "L", "XL"],
      "price": 29.99,
      "stock": 150,
      "category_id": 1,
      "category_name": "Men's Clothing",
      "category_slug": "mens-clothing",
      "img_urls": [
        "uploads/products/shirt-1.jpg",
        "uploads/products/shirt-2.jpg"
      ],
      "created_at": "2026-01-15T10:30:00.000Z"
    },
    {
      "id": 2,
      "name": "Premium Polo Shirt",
      "slug": "premium-polo-shirt",
      "description": "High-quality polo shirt with modern fit",
      "variant": ["M", "L", "XL"],
      "price": 39.99,
      "stock": 85,
      "category_id": 1,
      "category_name": "Men's Clothing",
      "category_slug": "mens-clothing",
      "img_urls": [
        "uploads/products/polo-1.jpg"
      ],
      "created_at": "2026-01-20T14:20:00.000Z"
    }
  ],
  "metadata": {
    "currentPage": 1,
    "totalPages": 5,
    "totalItems": 48,
    "itemsPerPage": 10,
    "category": {
      "id": 1,
      "name": "Men's Clothing",
      "slug": "mens-clothing"
    }
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us