Check topic subscriber

Check if a subscriber belongs to a certain topic

Authorization

Authorization<token>

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

In: header

Path Parameters

externalSubscriberIdRequiredstring

The external subscriber id

topicKeyRequiredstring

The topic key

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

_organizationIdRequiredstring

Unique identifier for the organization

_environmentIdRequiredstring

Unique identifier for the environment

_subscriberIdRequiredstring

Unique identifier for the subscriber

_topicIdRequiredstring

Unique identifier for the topic

topicKeyRequiredstring

Key associated with the topic

externalSubscriberIdRequiredstring

External identifier for the subscriber

export interface Response {
  /**
   * Unique identifier for the organization
   */
  _organizationId: string;
  /**
   * Unique identifier for the environment
   */
  _environmentId: string;
  /**
   * Unique identifier for the subscriber
   */
  _subscriberId: string;
  /**
   * Unique identifier for the topic
   */
  _topicId: string;
  /**
   * Key associated with the topic
   */
  topicKey: string;
  /**
   * External identifier for the subscriber
   */
  externalSubscriberId: string;
}

curl -X GET "https://api.novu.co/v1/topics/string/subscribers/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "_organizationId": "org_123456789",
  "_environmentId": "env_123456789",
  "_subscriberId": "sub_123456789",
  "_topicId": "topic_123456789",
  "topicKey": "my_topic_key",
  "externalSubscriberId": "external_subscriber_123"
}

List topic subscriptions GET

Previous Page

Notification event schema

Next Page