---
title: "Get Notification Enrollment – Retrieves the notification enrollment details for an account."
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/notification/enrollment"
tags: ["Notification"]
---

# Get Notification Enrollment – Retrieves the notification enrollment details for an account.

`GET /programs/{programCode}/accounts/{accountIdentifier}/notification/enrollment`

Retrieves the notification enrollment details for an account, including notification preferences and contact information. Requires account identifier and program code. Returns enrollment details and status.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetNotificationEnrollmentResponse — Represents the response returned after retrieving notification enrollment details for an account. Contains the account identifier and a list of notification enrollments, each with preferences, contacts, rules, and scheduling information. Used to provide the current notification enrollment configuration and status for a specific account within a partner program.
  - `accountIdentifier` string, nullable — The unique identifier of the account whose notification enrollment details are returned. Used to correlate the response with the requested account.
  - `enrollments` NotificationEnrollment[], nullable — The list of notification enrollments for the account. Each enrollment contains notification type, delivery contacts, rules, start date, and frequency.
    - `notificationTypeKey` integer, nullable — The key representing the notification type to enroll for (e.g., transaction alert, balance update). Used to specify which type of notification the enrollment applies to.
    - `contacts` NotificationEnrollmentContact[], nullable — The list of contacts for notification delivery, such as email addresses or phone numbers. Each contact specifies the delivery channel and contact value.
      - `channelType` string, nullable — The type of delivery channel for the notification (e.g., "email", "sms", "push"). Determines how the notification will be sent to the contact.
      - `contactValue` string, nullable — The value of the contact for notification delivery (e.g., email address, phone number, device token). Used as the destination for sending notifications.
      - `isActive` boolean, nullable — Indicates whether this contact is currently active for notification delivery. If true, notifications will be sent to this contact; if false, delivery is disabled.
    - `enrollmentRules` NotificationEnrollmentRule[], nullable — The list of rules that govern when and how notifications are sent. Each rule defines attributes, conditions, and activation status for notification delivery.
      - `attributeKey` integer — The key representing the attribute to evaluate for the rule (e.g., account status, transaction type). Used to identify which account or event attribute the rule applies to.
      - `attributeValue` string, nullable — The value of the attribute to match for the rule (e.g., "active", "deposit"). Used to specify the expected value for the attribute in order for the rule to trigger.
      - `condition` string, nullable — The condition to apply for the rule (e.g., "equals", "greaterThan", "contains"). Determines how the attribute and value are compared to trigger notification delivery.
      - `isActive` boolean — Indicates whether this rule is currently active. If true, the rule will be evaluated for notification delivery; if false, the rule is ignored.
    - `startDate` string, date-time, nullable — The date when the notification enrollment becomes active. Used to schedule the start of notification delivery.
    - `frequency` string, nullable — The frequency of notification delivery (e.g., "daily", "immediate", "weekly"). Used to control how often notifications are sent to the enrolled contacts.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)