Blog

List blog categories

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

Returns every category of the workspace's blog, newest first. Not paginated. 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

Response

200 The workspace's categories object
categories object[] | null required

Every category, newest first. null rather than [] when there are none.

Show 5 child attributes Hide 5 child attributes
id string required

Server-generated UUID.

Example 7c9e6679-7425-40de-944b-e07fc1f90ae7
slug string required

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

Example product
settings object required
Show 3 child attributes Hide 3 child attributes
name string required
Example Product
description string
Example Release notes and product announcements.
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
created_at string<date-time> required
updated_at string<date-time> required
total_count integer required
Example 3
400 Bad request - missing workspace_id 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