GET
/
v1
/
topics
import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.topics.list({
    key: "exampleKey",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "data": [],
  "page": 1,
  "pageSize": 10,
  "totalCount": 10
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Headers

​
idempotency-key
string

A header for idempotency purposes

Query Parameters

​
page
integer
default:
0

The page number to retrieve (starts from 0)

​
pageSize
integer
default:
10

The number of items to return per page (default: 10)

​
key
string

A filter key to apply to the results

Response

200
application/json
​
data
object[]
required

The list of topics

​
page
number
required

The current page number

​
pageSize
number
required

The number of items per page

​
totalCount
number
required

The total number of items

Was this page helpful?

Suggest editsRaise issue