List Categories

Retrieve a list of all categories

GET /api/categories

List Categories

cURL

curl --request GET \
  --url https://api.example.com/api/categories

{
  "categories": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "Technology",
      "slug": "technology",
      "description": "Articles about technology and innovation",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "name": "Travel",
      "slug": "travel",
      "description": "Travel guides and tips",
      "createdAt": "2024-01-16T14:20:00.000Z"
    }
  ]
}

Retrieves all categories sorted alphabetically by name. This endpoint is publicly accessible and does not require authentication.

Request

No request body or parameters required.

Headers

No authentication required.

Response

categories · array

Array of category objects

Show Category Object

_id · string

Unique identifier for the category

name · string

Display name of the category

slug · string

URL-friendly identifier for the category

description · string

Optional description of the category

createdAt · string

ISO 8601 timestamp of when the category was created

{
  "categories": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "Technology",
      "slug": "technology",
      "description": "Articles about technology and innovation",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "name": "Travel",
      "slug": "travel",
      "description": "Travel guides and tips",
      "createdAt": "2024-01-16T14:20:00.000Z"
    }
  ]
}

Error Responses

error · string

Error message describing what went wrong

500 - Internal Server Error

{
  "error": "Database connection failed"
}

Example Request

cURL

curl https://api.vaniyk-empire.com/api/categories