Subscribers

Retrieve a subscriber

Retrieve a subscriber by its unique key identifier subscriberId. subscriberId field is required.

get/v2/subscribers/{subscriberId}

Path parameters

subscriberIdstring required

The identifier of the subscriber

Headers

idempotency-keystring

A header for idempotency purposes

Response

_idstring

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

firstNamestring nullable

The first name of the subscriber.

lastNamestring nullable

The last name of the subscriber.

emailstring nullable

The email address of the subscriber.

phonestring nullable

The phone number of the subscriber.

avatarstring nullable

The URL of the subscriber's avatar image.

localestring nullable

The locale setting of the subscriber, indicating their preferred language or region.

topicsstring[]

An array of topics that the subscriber is subscribed to.

isOnlineboolean nullable

Indicates whether the subscriber is currently online.

lastOnlineAtstring nullable

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

__vnumber

The version of the subscriber document.

dataobject nullable

Additional custom data for the subscriber

timezonestring nullable

Timezone of the subscriber

subscriberIdstring required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

_organizationIdstring required

The unique identifier of the organization to which the subscriber belongs.

_environmentIdstring required

The unique identifier of the environment associated with this subscriber.

deletedboolean required

Indicates whether the subscriber has been deleted.

createdAtstring required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

updatedAtstring required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

Example response

{
  "channels": [
    {
      "credentials": {
        "webhookUrl": "https://example.com/webhook",
        "channel": "general",
        "deviceTokens": [
          "token1",
          "token2",
          "token3"
        ],
        "alertUid": "12345-abcde",
        "title": "Critical Alert",
        "imageUrl": "https://example.com/image.png",
        "state": "resolved",
        "externalUrl": "https://example.com/details"
      }
    }
  ]
}

Changes

Changed in 4 of the 12 revisions of this API.62

Aug 30, 202624e82408dec711See the full diff
- ●
  added the new novu-web-chat enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added
- ○
  removed the novu-agent-chat enum value from the channels/items/providerId response property for the response status 200
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 16, 2026c2b2fa0d5d4811See the full diff
- ●
  added the new novu-agent-chat enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added
- ○
  removed the novu-web-chat enum value from the channels/items/providerId response property for the response status 200
  response-property-enum-value-removed
Jul 31, 20268092e41edd571See the full diff
- ●
  added the new novu-web-chat enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 21, 2026c69777f601843See the full diff
- ●
  added the new line enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new sendblue enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new webex-messaging enum value to the channels/items/providerId response property for the response status 200
  response-property-enum-value-added

Full history