GET
/
blogs
/
v3
/
topics
/
search
Search blog topics
curl --request GET \
  --url https://api.hubapi.com/blogs/v3/topics/search \
  --header 'Authorization: Bearer <token>'
{
  "limit": 100,
  "objects": [
    {
      "associatedBlogIds": [],
      "created": 1435001222059,
      "deletedAt": 0,
      "description": "tester9",
      "id": 2986692016,
      "livePosts": 0,
      "name": "tester9",
      "portalId": 62515,
      "slug": "tester9",
      "status": "inactive",
      "totalPosts": 0,
      "updated": 1435001222059
    },
    {
      "associatedBlogIds": [],
      "created": 1435000911447,
      "deletedAt": 0,
      "description": "tester7",
      "id": 3002998727,
      "livePosts": 0,
      "name": "tester7",
      "portalId": 62515,
      "slug": "tester7",
      "status": "inactive",
      "totalPosts": 0,
      "updated": 1435000911447
    },
    {
      "associatedBlogIds": [],
      "created": 1435001176206,
      "deletedAt": 0,
      "description": "tester8",
      "id": 3009829029,
      "livePosts": 0,
      "name": "tester8",
      "portalId": 62515,
      "slug": "tester8",
      "status": "inactive",
      "totalPosts": 0,
      "updated": 1435001176206
    }
  ],
  "offset": 0,
  "total": 3,
  "totalCount": 3
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
id
string

Search for topics by id. Supports exact value matching and the 'in' range filter (e.g. id__in=348109009,348109019)

​
name
string

Search for topics by name. Supports exact value matching, 'contains' searching, and 'icontains' case-insensitive searching (e.g. name__contains=topic1)

​
slug
string

Search for topics by slug. Supports exact value matching

​
created
integer

Filter results by creation date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte

​
limit
integer
default:100

The maximum number of items to return. Defaults to 100.

​
offset
integer
default:0

The offset from the beginning of the result set from which to start returning results. Used for paging. Defaults to 0.

​
casing
enum<string>

Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and 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.

Available options:
snake
​
q
string

Search for topics whose names or url slugs contain the given string.

​
active
boolean

Filter topics by whether or not they are associated with any published blog posts (true or false).

​
blog
integer

Filter topics by a blog they are used on (value is a blog ID).

Response

200
application/json

successful operation

The response is of type object.