Blog

Get a blog category

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

Retrieves a category by id or by slug; when both are given, id wins. 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
id string

The category ID. Either id or slug is required.

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

The category slug. Either id or slug is required.

  • Example: product

Response

200 The category object
category object required
Show 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 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 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
400 Bad request - missing 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.

  • Available options: read, write
500 Internal server error. Also returned when no category matches the id or slug. object
error string required

Error message