AstraCMS
Categories

List categories

Get a paginated list of categories with post counts

GET
/v1/{workspaceId}/categories

Path Parameters

workspaceId*string

Workspace identifier

Query Parameters

limit?string

Number of categories per page

Default"10"
page?string

Page number for pagination

Default"1"
include?string

Related resources to include (e.g., posts)

Response Body

application/json

application/json

application/json

curl -X GET "https://api.astracms.dev/v1/my-workspace/categories"
{
  "categories": [
    {
      "id": "clx2k4m6n8p0r2t4v6x8z",
      "name": "Technology",
      "slug": "technology",
      "description": "Tech articles and news",
      "count": {
        "posts": 42
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "currentPage": 1,
    "nextPage": 2,
    "previousPage": null,
    "totalPages": 5,
    "totalItems": 48
  }
}
{
  "error": "string",
  "details": null,
  "message": "string"
}
{
  "error": "string",
  "details": null,
  "message": "string"
}

Last updated on