SubscriberResponseDto

January 14, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
idOptional<String>:heavy_minus_sign: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.
firstNameJsonNullable<String>:heavy_minus_sign:The first name of the subscriber.
lastNameJsonNullable<String>:heavy_minus_sign:The last name of the subscriber.
emailJsonNullable<String>:heavy_minus_sign:The email address of the subscriber.
phoneJsonNullable<String>:heavy_minus_sign:The phone number of the subscriber.
avatarJsonNullable<String>:heavy_minus_sign:The URL of the subscriber's avatar image.
localeJsonNullable<String>:heavy_minus_sign:The locale setting of the subscriber, indicating their preferred language or region.
channelsList<ChannelSettingsDto>:heavy_minus_sign:An array of channel settings associated with the subscriber.
topicsList<String>:heavy_minus_sign:: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

An array of topics that the subscriber is subscribed to.
isOnlineJsonNullable<Boolean>:heavy_minus_sign:Indicates whether the subscriber is currently online.
lastOnlineAtJsonNullable<String>:heavy_minus_sign:The timestamp indicating when the subscriber was last online, in ISO 8601 format.
vOptional<Double>:heavy_minus_sign:The version of the subscriber document.
dataMap<String, Object>:heavy_minus_sign:Additional custom data for the subscriber
timezoneJsonNullable<String>:heavy_minus_sign:Timezone of the subscriber
subscriberIdString:heavy_check_mark:The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
organizationIdString:heavy_check_mark:The unique identifier of the organization to which the subscriber belongs.
environmentIdString:heavy_check_mark:The unique identifier of the environment associated with this subscriber.
deletedboolean:heavy_check_mark:Indicates whether the subscriber has been deleted.
createdAtString:heavy_check_mark:The timestamp indicating when the subscriber was created, in ISO 8601 format.
updatedAtString:heavy_check_mark:The timestamp indicating when the subscriber was last updated, in ISO 8601 format.