Skip to main content
GET
/
api
/
v2
/
categories
{
  "success": true,
  "message": "Categories fetched successfully.",
  "data": [
    {
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Bags",
      "description": "Luxury handbags and purses",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    },
    {
      "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Watches",
      "description": "Luxury timepieces and accessories",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ],
  "metadata": {
    "total_count": 2,
    "page_number": 1,
    "total_pages": 1,
    "page_size": 20
  }
}

Authorizations

x-api-key
string
header
required

API key for application authentication (format: leo_xxxxxxxxx)

Query Parameters

page_size
integer
default:20

Number of results per page

Required range: 1 <= x <= 100
page_number
integer
default:1

Page number

Required range: x >= 1
search_query
string

Search term for category names

activeOnly
boolean
default:false

Filter to only active categories

Response

200 - application/json

Categories retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Categories fetched successfully."

data
any
metadata
object