SubscriberResponseDto
January 14, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | Optional<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. |
firstName | JsonNullable<String> | :heavy_minus_sign: | The first name of the subscriber. |
lastName | JsonNullable<String> | :heavy_minus_sign: | The last name of the subscriber. |
email | JsonNullable<String> | :heavy_minus_sign: | The email address of the subscriber. |
phone | JsonNullable<String> | :heavy_minus_sign: | The phone number of the subscriber. |
avatar | JsonNullable<String> | :heavy_minus_sign: | The URL of the subscriber's avatar image. |
locale | JsonNullable<String> | :heavy_minus_sign: | The locale setting of the subscriber, indicating their preferred language or region. |
channels | List<ChannelSettingsDto> | :heavy_minus_sign: | An array of channel settings associated with the subscriber. |
topics | List<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. |
isOnline | JsonNullable<Boolean> | :heavy_minus_sign: | Indicates whether the subscriber is currently online. |
lastOnlineAt | JsonNullable<String> | :heavy_minus_sign: | The timestamp indicating when the subscriber was last online, in ISO 8601 format. |
v | Optional<Double> | :heavy_minus_sign: | The version of the subscriber document. |
data | Map<String, Object> | :heavy_minus_sign: | Additional custom data for the subscriber |
timezone | JsonNullable<String> | :heavy_minus_sign: | Timezone of the subscriber |
subscriberId | String | :heavy_check_mark: | The identifier used to create this subscriber, which typically corresponds to the user ID in your system. |
organizationId | String | :heavy_check_mark: | The unique identifier of the organization to which the subscriber belongs. |
environmentId | String | :heavy_check_mark: | The unique identifier of the environment associated with this subscriber. |
deleted | boolean | :heavy_check_mark: | Indicates whether the subscriber has been deleted. |
createdAt | String | :heavy_check_mark: | The timestamp indicating when the subscriber was created, in ISO 8601 format. |
updatedAt | String | :heavy_check_mark: | The timestamp indicating when the subscriber was last updated, in ISO 8601 format. |