Get Notification Message

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

Get the notification message of the organization & notification message ID.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`notificationMessageId`	path	string	yes	Notification Message ID

Responses

200 — OK

Content-Type: application/json · Schema: NotificationMessage

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`	NotificationmessageType	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

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/org/{orgId}/notificationMessage/{notificationMessageId}' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "creationTime": "2026-01-31T12:00:00Z",
  "id": "01H0000000000000000000",
  "info": {
    "action": "",
    "bccRecipients": [
      "string"
    ],
    "ccRecipients": [
      "string"
    ],
    "customFields": {},
    "htmlContent": "string",
    "standardFields": {},
    "subject": "string",
    "textContent": "string"
  },
  "organizationID": "01H0000000000000000000",
  "recipient": "string",
  "type": "EMAIL"
}

Error — 400

"string"

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.