Blog

List blog posts

GET https://demo.notifuse.com/api/blogPosts.list

Returns posts page by page, drafts included unless filtered out. Posts come by the date they are known by, newest first: their publication date (a scheduled post's date to come included), or for a draft its last edit; with status=draft, most recently edited first; with status=published, most recently published first; with status=scheduled, soonest to publish first. Page through with page and limit until you have total_count posts. Requires the blog read permission.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

workspace_id string required

The ID of the workspace

Example ws_1234567890
category_id string

Only posts in this category.

Example 7c9e6679-7425-40de-944b-e07fc1f90ae7
status string

draft is posts never published or since unpublished; published is every post with a publication date, including one dated in the future; scheduled is only posts whose publication date is still to come.

Default all Options all, draft, published, scheduled Example published
search string

Only posts whose title contains this text, case-insensitively. Leading and trailing spaces are ignored; total_count counts the matching posts.

Max length 200 Example release notes
page integer

1-indexed page number.

Default 1 Min 1 Example 2
limit integer

Posts per page. Values above the maximum are clamped to it rather than refused.

Default 50 Max 100 Example 50

Response

200 One page of posts object
posts object[] | null required

The requested page. null rather than [] when the page is empty.

Show 7 child attributes Hide 7 child attributes
id string required

Server-generated UUID.

Example 1b4e28ba-2fa1-11d2-883f-0016d3cca427
category_id string required
Example 7c9e6679-7425-40de-944b-e07fc1f90ae7
slug string required

The post's path segment on the blog (/{category_slug}/{post_slug}).

Example october-release
settings object required
Show 7 child attributes Hide 7 child attributes
title string required

The post's H1.

Example What shipped in October
template object required

The web template holding the post body.

Show 2 child attributes Hide 2 child attributes
template_id string required
Example blog_october_release
template_version integer required

The template version the post renders. 0 means the latest version, whatever it is at render time.

Example 3
excerpt string
Example A faster editor, scheduled broadcasts and a new API.
featured_image_url string
Example https://cdn.example.com/blog/october.png
authors object[] | null
Show 2 child attributes Hide 2 child attributes
name string required
Example Jane Doe
avatar_url string
Example https://cdn.example.com/avatars/jane.png
reading_time_minutes integer required

Displayed as given; not computed from the body.

Example 4
seo object

Search and social metadata for the page, exposed to the blog theme.

Show 8 child attributes Hide 8 child attributes
meta_title string
Example Release notes for October
meta_description string
Example Everything that shipped this month.
og_title string

Open Graph title

og_description string

Open Graph description

og_image string

Open Graph image URL

Example https://cdn.example.com/og/october.png
canonical_url string
Example https://blog.example.com/product/october-release
keywords string[]
meta_robots string

Content of the robots meta tag.

Example index,follow
published_at string<date-time>

Absent while the post is a draft.

Example 2026-10-01T09:00:00Z
created_at string<date-time> required
updated_at string<date-time> required
total_count integer required

Posts matching the filters across all pages.

Example 128
400 Bad request - invalid query parameters object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

403 Forbidden - missing the blog read permission object
error string required

Error message

resource string required

The permission resource the endpoint requires.

Example blog
permission string required

The access level the endpoint requires on that resource.

Options read, write
500 Internal server error object
error string required

Error message