NOnovu
Topics

List all topics

Changed on

This api returns a paginated list of topics. Topics can be filtered by key, name, or includeCursor to paginate through the list. Checkout all available filters in the query section.

get/v2/topics

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber
Example:10

Limit the number of items to return (max 100)

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

keystring

Key of the topic to filter results.

namestring

Name of the topic to filter results.

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Example response

{
  "data": [
    {
      "_id": "64da692e9a94fb2e6449ad06",
      "key": "product-updates",
      "name": "Product Updates",
      "data": {
        "category": "product",
        "priority": 1
      },
      "createdAt": "2023-08-15T00:00:00.000Z",
      "updatedAt": "2023-08-15T00:00:00.000Z"
    }
  ]
}

Changes