Get a blog topic by ID

GET /blogs/v3/topics/:topic-id

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Get the details for a specific topic by its ID.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
topic-id Used in the request URL Unique identifier for a particular topic

Optional query string parameters

Parameter name Description
casing Use the casing=snake parameter to change the API's casing for returned JSON fields (below) to snake_case, rather than camelCase, which is the default. This option is provided for backwards-compatibility and ease of migration from Content v2 APIs, which used snake_case.

JSON Fields returned in the response

Field name Type Description
id string The unique id of the topic
portalId string The hub id
created long When the topic was first created, in milliseconds since the epoch
updated long When the topic was last updated, in milliseconds since the epoch
deletedAt long When the topic was deleted, in milliseconds since the epoch. Zero if the topic was never deleted. Use a DELETE request to properly soft delete a topic - do not set this value directly.
name string The topic name
slug string The URL-friendly version of the topic, used in blog urls
description string The topic description