> **Source:** https://knowledge.leegality.com/document-execution/api/list-nesl-notifications > **Site:** Leegality Knowledge Base — https://knowledge.leegality.com > **About:** Leegality is a document execution platform covering eSigning, stamps, NeSL, workflows, and REST API integration. > **Navigation:** Every article on this site has a plain-text version at `.txt` (this format). To get an index of all articles with their `.txt` links, read: https://knowledge.leegality.com/llms.txt > **AI Guide:** For instructions on how to navigate this knowledge base as an AI agent, read: https://knowledge.leegality.com/ai-readable.txt --- # GET /v3.3/nesl/notification/list — List eBG notifications Returns a list of NeSL eBG (Electronic Bank Guarantee) event notifications. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.3/nesl/notification/list?q={q}&status={status}&requestType={requestType}&sentToMe={sentToMe}&max={max}&offset={offset} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.3/nesl/notification/list` - Sandbox: `https://sandbox.leegality.com/api/v3.3/nesl/notification/list` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `q` | query | No | string | Search by loan number. Returns all eBG notifications associated with the specified loan number. | — | | `status` | query | No | string | Filter notifications by review status. **Possible values:** `ACCEPTED`, `REJECTED`, `PENDING`. | — | | `requestType` | query | No | string | Filter notifications by eBG event type. **Possible values:** `AMENDMENT`, `RENEWAL`, `EXTEND_OR_PAY`, `CANCELLATION`, `CLOSURE`, `PARTIAL_INVOCATION`, `INVOCATION`. | — | | `sentToMe` | query | No | boolean | Filter by notification recipient. When `true`, returns only notifications sent to the current API user. When `false`, returns all notifications received by any user in the organization. **Default:** `false` | — | | `max` | query | No | integer | Maximum number of results to return. | — | | `offset` | query | No | integer | Number of records to skip before returning results. Use with `max` for pagination. | — | --- ## Responses ### 200 — eBG notifications retrieved successfully. Response wrapper for the List eBG Notifications API. On success (`status: 1`), `data` contains the notification list and total count. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `status` | integer | No | API response status. `1` = success, `0` = failure. Allowed: `0`, `1`. | `1` | | `messages` | array\ | No | Array of response messages. Empty array `[]` on success. See **Message** below. | — | | `data` | NeslNotificationListData | No | Contains the list of eBG notifications and the total count. See **NeslNotificationListData** below. | — | #### Message Message object containing a machine-readable code and a human-readable description. Used for success confirmations, errors, and warnings. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `code` | string | No | Response message code. | `simpleWorkFlow.success` | | `message` | string | No | Human-readable success or error message. | `Invitations sent successfully.` | #### NeslNotificationListData Contains the list of eBG notifications and the total count. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `notificationList` | array\ | No | Array of eBG notification objects. See **NeslNotificationItem** below. | — | | `totalCount` | integer | No | Total number of notification records matching the query. Use with `max` and `offset` for pagination. | `5` | ##### NeslNotificationItem Details of a single NeSL eBG event notification. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `eventType` | string | No | Type of the eBG event. **Possible values:** `Amendment`, `Renewal`, `Extend_or_pay`, `Cancellation`, `Closure`, `Partial_invocation`, `Invocation`. | `Invocation` | | `lastUpdated` | string | No | Timestamp of the most recent update to the notification. **Format:** ISO 8601 (e.g., `"2025-08-24T14:15:22Z"`). | `2025-08-24T14:15:22Z` | | `loanNo` | string | No | Loan number associated with the eBG notification. | `LOAN001` | | `notifTxnId` | string | No | Unique notification transaction ID. | `NTX12345` | | `requestId` | string | No | Request ID associated with the eBG notification. | `REQ001` | | `reviewedBy` | string | No | Name of the user who reviewed the notification. Empty or null if not yet reviewed. | `John Doe` | | `status` | string | No | Review status of the notification. **Possible values:** `Accepted`, `Rejected`, `Pending`. | `Pending` | ### Sample Response (200) ```json { "status": 1, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "notificationList": [ { "eventType": "Invocation", "lastUpdated": "2025-08-24T14:15:22Z", "loanNo": "LOAN001", "notifTxnId": "NTX12345", "requestId": "REQ001", "reviewedBy": "John Doe", "status": "Pending" } ], "totalCount": 5 } } ```