Search Documentation

Search for a documentation page...

Blog Categories API

REST API endpoints for managing blog post categories.

Categories organize blog posts into logical groups for navigation and filtering.

List Blog Categories

GET /api/v1/blog-categories

Query Parameters

ParameterTypeDefaultDescription
limitnumber50Categories per page (1-100)
offsetnumber0Categories to skip
querystring—Search by name or slug
activeboolean—Filter by active status

Response

{
  "data": [
    {
      "id": "0191abc0-1234-7def-8000-000000000001",
      "storeId": "store-123",
      "name": "Tutorials",
      "slug": "tutorials",
      "description": "Step-by-step guides and how-tos",
      "image": "https://cdn.example.com/tutorials.jpg",
      "position": "0|aaaaaa:",
      "active": true,
      "seo": {},
      "createdAt": "2024-01-10T08:30:00.000Z",
      "updatedAt": "2024-01-10T08:30:00.000Z",
      "postCount": 5
    }
  ],
  "meta": {
    "count": 1,
    "offset": 0,
    "limit": 50
  }
}

Get Blog Category

GET /api/v1/blog-categories/:idOrSlug

Returns a single blog category by UUID or slug.

Response

{
  "id": "0191abc0-1234-7def-8000-000000000001",
  "storeId": "store-123",
  "name": "Tutorials",
  "slug": "tutorials",
  "description": "Step-by-step guides and how-tos",
  "image": "https://cdn.example.com/tutorials.jpg",
  "position": "0|aaaaaa:",
  "active": true,
  "seo": {
    "title": "Tutorials - Our Blog",
    "description": "Browse our tutorial articles"
  },
  "createdAt": "2024-01-10T08:30:00.000Z",
  "updatedAt": "2024-01-10T08:30:00.000Z"
}
PreviousPostsAPI ReferenceNextSubscribersAPI Reference