Topics

Retrieve a topic

Changed on

Retrieve a topic by its unique key identifier topicKey

get/v2/topics/{topicKey}

Request

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

Path parameters

topicKeystring required

The key identifier of the topic

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

_idstring required

The identifier of the topic

keystring required

The unique key of the topic

namestring

The name of the topic

dataobject

Additional custom data associated with the topic

createdAtstring

The date the topic was created

updatedAtstring

The date the topic was last updated

Example response

{
  "_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