# list notification messages

`GET https://api.suger.cloud/org/{orgId}/notificationMessage`

List or search the notification messages of the given organization with pagination.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `orgId` | path | string | yes | Organization ID |
| `limit` | query | integer | no | List pagination size, default 1000, max value is 1000 |
| `keyword` | query | string | no | Keyword to search in subject/content |
| `offset` | query | integer | no | List pagination offset, default 0 |

## Responses

### 200 — OK

Content-Type: `application/json` · Schema: `ListNotificationMessagesResponse`

**`ListNotificationMessagesResponse`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `nextOffset` | integer | no | The next offset to use in the next request to get the next page of notification messages. If this field is null, there are no more notification messages to get. |
| `notificationMessages` | array<orm.NotificationMessage> | no |  |
| `totalCount` | integer | no | The total number of notification messages. Only available when the request is made with the first offset = 0. |

**`orm.NotificationMessage`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `creationTime` | string | no | CreationTime holds the value of the "creation_time" field. |
| `id` | string | no | ID of the ent. |
| `info` | NotificationMessageInfo | no |  |
| `organizationID` | string | no | OrganizationID holds the value of the "organization_id" field. |
| `recipient` | string | no | supports multiple recipients as a comma-separated string |
| `type` | notificationmessage.Type | no |  |

**`NotificationMessageInfo`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | NotificationEventAction | no |  |
| `bccRecipients` | array<string> | no |  |
| `ccRecipients` | array<string> | no |  |
| `customFields` | object | no | All other fields |
| `htmlContent` | string | no | The HTML content of the email. |
| `standardFields` | object | no | The standard fields to render the email content. |
| `subject` | string | no |  |
| `textContent` | string | no | The text content of the email in case the recipient's email client does not support HTML. |

### 400 — Bad request error

Content-Type: `application/json`

### 500 — Internal server error

Content-Type: `application/json`

---

Interactive API reference: https://doc.suger.io/api/