Skip to content

Categories

The Categories resource provides fake product category data with names, slugs, descriptions, and images.

MethodEndpointDescription
GET/v1/categoriesList all categories
GET/v1/categories/:idGet a specific category
GET/v1/categories/:id/productsGet category's products
{
"id": 1,
"name": "Electronics",
"slug": "electronics",
"description": "Electronic devices and gadgets",
"image": "https://example.com/images/electronics.jpg"
}
Field Type Description
id number Unique identifier
name string Category name
slug string URL-friendly unique slug
description string Category description
image string Category image URL
Terminal window
curl https://api.phantomjson.app/v1/categories
Parameter Type Default Description
page number 1 Page number
limit number 20 Items per page (max: 100)
sort string Sort field and direction
q string Search query
fields string Fields to return
name string Filter by name
{
"data": [
{
"id": 1,
"name": "Electronics",
"slug": "electronics",
"description": "Electronic devices and gadgets"
}
],
"meta": {
"total": 20,
"page": 1,
"limit": 20,
"totalPages": 1
}
}
Terminal window
curl https://api.phantomjson.app/v1/categories/1
{
"data": {
"id": 1,
"name": "Electronics",
"slug": "electronics",
"description": "Electronic devices and gadgets",
"image": "https://example.com/images/electronics.jpg"
}
}
Terminal window
curl https://api.phantomjson.app/v1/categories/1/products
{
"data": [
{
"id": 1,
"name": "Ergonomic Rubber Keyboard",
"slug": "ergonomic-rubber-keyboard",
"price": 299.99,
"categoryId": 1
}
],
"meta": {
"total": 50,
"page": 1,
"limit": 20,
"totalPages": 3
}
}
Terminal window
curl "https://api.phantomjson.app/v1/categories?q=electronics"
Terminal window
curl "https://api.phantomjson.app/v1/categories?sort=name:asc"
Terminal window
curl "https://api.phantomjson.app/v1/categories?fields=id,name,slug"
  • Products — Each category has many products (access via /v1/categories/:id/products)