Hive API Docs
API Reference

Response Shapes API

Complete payload contract for public endpoints

PostSummary

type PostSummary = {
  title: string;
  slug: string;
  excerpt: string;
  publishedAt: string | null;
  updatedAt: string | null;
  category: { name: string; slug: string } | null;
  tags: Array<{ name: string; slug: string }>;
  author: { id: string; name: string } | null;
};

PostDetail

type PostDetail = PostSummary & { htmlContent: string };

PostListResponse

type PostListResponse = {
  data: PostSummary[];
  total: number;
  offset: number;
  limit: number;
};

Tag and Category

type Tag = { name: string; slug: string };
type Category = { name: string; slug: string };

Author

type Author = {
  id: string;
  name: string;
  about: string;
  socialLinks: Record<string, unknown>;
};

Stats

type Stats = {
  totalPosts: number;
  totalAuthors: number;
  totalCategories: number;
  totalTags: number;
};

Error payload

type ErrorResponse = {
  message: string;
};

On this page