--- title: "Get a specific notification" method: GET path: "/notification/{id}" tags: ["Notification"] --- # Get a specific notification `GET /notification/{id}` Get a specific notification ## Path parameters - `id` string, required ## Response `200` OK - object - `notification` NotificationModel - `_id` string - `application` string - `medium` 'push' | 'email' | 'sms' — The medium of the message - `scope` 'application' | 'criteria' | 'event' | 'segments' | 'tags' | 'user' | 'device' — The scope of the audience - `triggered` boolean — Message was used for a trigger or automation - `archived` boolean — Message was archived - `time` string, date-time - `subject` string — Subject of your email message - `sender` MessageSender — An object containing the sender name and address for this template. Applicable only for email templates. - `address` string, required — the local part of the email address - `name` string, required - `replyTo` string — a fully-qualified email address to be used as reply-to. Allows placeholders. - `openTracking` boolean — If set to false, will disable tracking of the message being opened - `linkTracking` boolean — If set to false, will disable tracking of clicks on links in the message - `useListHeaders` boolean — If set to true, include List-Unsubscribe headers - `criteria` Criteria — Criteria to select an audience - `locationsCriteria` LocationsCriteria[] — Device locations criteria - `locations` union[] — Filter or select devices based on their location. Locations can be circular or polygon-shaped. - union - Polygon - … - Circle - … - `quantifier` 'all' | 'any' | 'none' — `all` means devices that are in all of these locations, `any` means devices that are in one or more of these locations, `none` means devices that are in none of these locations - `propertiesCriteria` PropertiesCriteria[] — Device properties criteria - PropertiesCriterion[] — A list of filters for device properties. The results are intersected / AND'ed - `description` unknown - `operator` 'eq' | 'ne' | 'lt' | 'lte' | 'gt' | 'gte' | 'in' | 'nin' - `property` string — Filter or select devices based on the value of their properties. - `value` union - string - string[] - `segmentsCriteria` SegmentsCriteria[] — User segments criteria - `quantifier` 'all' | 'any' | 'none' — `all` means users that are in all of these segments, `any` means users that are in one or more of these segments, `none` means users that are in none of these segments - `segments` ObjectId[] — Filter or select users based on these segments. - `tagsCriteria` TagsCriteria[] — Device tags criteria - `tags` string[] — Filter or select devices based on these tags. - `quantifier` 'all' | 'any' | 'none' — `all` means devices that have all these tags, `any` means devices that have one or more of these tags, `none` means devices that have none of these tags - `eventCriteria` EventCriteria - `data` object - `region` string — The region's id of an event of type re.notifica.event.region.Session or re.notifica.event.beacon.Session - `fence` string — The beacon's fence region id of an event of type re.notifica.event.beacon.Session - `pass` string — The pass id of an event of type re.notifica.event.pass.Add, re.notifica.event.pass.Remove or re.notifica.event.pass.Redeem - `serial` string, uuid — The pass serial of an event of type re.notifica.event.pass.Add, re.notifica.event.pass.Remove or re.notifica.event.pass.Redeem - `group` string — The asset group's id of an event of type re.notifica.event.asset.Load - `scannable` string — The scannable's id of an event of type re.notifica.event.scannable.Scan - `notification` string — The notification's id of an event of type re.notifica.event.notification.Sent, re.notifica.event.notification.Receive, re.notifica.event.notification.Open or re.notifica.event.notification.Influenced - `endDate` string, date-time, required — defaults to now - `startDate` string, date-time, required — defaults to now - `type` string, required - `location` MessageLocation - `distance` number, required - `latitude` number, required - `longitude` number, required - `segments` ObjectId[] — User segments this notification is sent to - `tags` string[] — Device tags this notification is sent to - `userID` string — The app-defined user identifier - `deviceID` string — The unique identifier for your device corresponding to the APNS, FCM or Webpush token. - `scheduled` boolean — When true will prevent the message from being sent. Additionally you will have to create a schedule task by calling the /notification/schedule. - `rate` number — The rate at which we will send notifications in seconds. If provided, we will not send more than x messages per second. - `languages` string[] — The list of localized content language identifiers used in localizedContent. When included, you must also provide a list of localizedContent objects in the same order. - `localizedContent` MessageLocalizedContent[] — Provides content for all the language identifiers provided in languages. - `actions` MessageAction[] - `type` string - `label` string - `target` string - `keyboard` boolean - `camera` boolean - `rules` MessageRule[] - `params` ObjectId[], required - `type` 're.notifica.rule.segment.Add' | 're.notifica.rule.segment.Remove' | 're.notifica.rule.tag.Add' | 're.notifica.rule.tag.Remove', required - `attachments` MessageAttachment[] - `mimeType` string, required — the image mime type - `name` string - `uri` string, uri, required — the URL to an image either uploaded into our platform or hosted in any public web server - `content` MessageContent[] - `type` string, required — type according to the type of push message. Please refer to Content types for all available types - `data` string, required — data according to the type of push message. Please refer to Content types for all available types - `message` string - `subject` string - `subtitle` string - `title` string - `type` string, required — Defines the type of content to show. Types of messages are represented by namespaces. Message types should match the following namespace: re.notifica.notification.*. Please refer to Message Types for all available types. - `title` string — Small text shown in the device's lock screen or notification center. This field should be used as an helper text to the message. Please note that this is only supported by iOS 10 or higher or Android 5 or higher devices. - `subtitle` string — Small text shown in the device's lock screen or notification center. This field should be used as an helper text to the message. Please note that this is only supported by iOS 10 or higher or Android 5 or higher devices. - `message` string, required — Short and concise message. This is the first thing your user sees, make sure it is relevant and that somehow summarizes what you intend to say. - `content` MessageContent[] — An array of Content objects according to the type of push message. Please refer to Content types for all available types. - `type` string, required — type according to the type of push message. Please refer to Content types for all available types - `data` string, required — data according to the type of push message. Please refer to Content types for all available types - `attachments` MessageAttachment[] — An object containing the URL to an image either uploaded into our platform or hosted in any public web server. - `mimeType` string, required — the image mime type - `name` string - `uri` string, uri, required — the URL to an image either uploaded into our platform or hosted in any public web server - `ttl` number — Number of seconds the message will be attempted to be delivered by APNS, GCM or HMS. - `rules` MessageRule[] — Adds one or more rules to a notification. An array of rules objects. Please refer to Rules objects for all types available. - `params` ObjectId[], required - `type` 're.notifica.rule.segment.Add' | 're.notifica.rule.segment.Remove' | 're.notifica.rule.tag.Add' | 're.notifica.rule.tag.Remove', required - `actionCategory` string — Use a previously created Rich Push template for your message. Use the name of the template for this property and the actions in that template as the actions for this notification. This will enable actionable notifications from the notification center in both iOS and Android. - `actions` MessageAction[] — Adds one or more interactions to a notification. An array of Action objects. Please refer to Action objects for all types available. - `type` string - `label` string - `target` string - `keyboard` boolean - `camera` boolean - `rules` MessageRule[] - `params` ObjectId[], required - `type` 're.notifica.rule.segment.Add' | 're.notifica.rule.segment.Remove' | 're.notifica.rule.tag.Add' | 're.notifica.rule.tag.Remove', required - `extra` MessageExtra — A valid one-level JSON object. This is useful if you need to send extra data that you will need to proccess soon the notification arrives. - `sound` string — Name of sound to play. `default` means use the default sound as set by the user, any other string will be looked up as sound file on the device (`mp3` on Android, `aiff` on iOS). - `lights` MessageLights — An object containing a color string ("white", "red", "#rrggbb", "#aarrggbb") and the on/off time in milliseconds. Colors are only applicable to Android and will be displayed by hardware as accurately as possible. - `color` string — Color string - `off` number — OFF time in milliseconds - `on` number — ON time in milliseconds - `channel` string — This is an Android only property. If the channel is defined in the app, the message will be sent to that channel, otherwise to the default channel. - `badge` number — This is an iOS only property. A badge will be displayed over your app icon whenever a notification arrives. Use a number from 1 to 9999. - `presentation` boolean — In iOS (2.1 and higher), will set presentation mode for foreground messages. In Android (2.1 and higher), it will set the presentation parameter to true in the foreground message handler. - `targetContentIdentifier` string — This is a iOS only property. It will be used to set a notification's targetContentIdentifier - `requireInteraction` boolean — This is a Web only property. In WebPush, will set the requireInteraction flag to true - `renotify` boolean — This is a Web only property. In WebPush, will set the renotify flag to true - `critical` boolean — This is a iOS only property. It will be used to indicate this is a critical notification - `criticalSoundVolume` number — This is a iOS only property. It will be used to set a critical notification's sound volume - `group` string — An identifier to be used by the operating systems in order to group specific notifications in the lock screen and notification center. Only supported in iOS 12 or higher and Android 6 or higher. In Android you must use our Notificare's SDK 2.1 or higher. - `push` boolean — This property is only available for SDKs 1.8.0 and up. When false it will only create a message in the app's inbox and not generate a remote notification. By default this property will be true. Please note that this property will be ignored if Inbox is not being used. - `inbox` boolean — This property is only available for SDKs 2.3.0 and up. When false it will not create a message in the app's inbox. By default this property will be true. Please note that this property will be ignored if Inbox is not being used. - `inboxTtl` number — This property is only available for SDKs 2.3.0 and up. When set it will expire the message in the device inbox after this amount of seconds. Please note that this property will be ignored if Inbox is not being used. - `overrideSendingLimit` boolean — If set to true, this message will not count against the sendingLimit for the application ## Changes - **2023-06-09** `e39017247cd9` — 2 warning, 2 info - removed the optional property `notification/allOf[#/components/schemas/NotificationPushBase]/allOf[subschema #2]/linkTracking` from the response with the `200` status - removed the optional property `notification/allOf[#/components/schemas/NotificationPushBase]/allOf[subschema #2]/openTracking` from the response with the `200` status - added the optional property `notification/allOf[subschema #1]/replyTo` to the response with the `200` status - added the optional property `notification/allOf[subschema #1]/useListHeaders` to the response with the `200` status - **2023-02-02** `79a63d26fb78` — 2 breaking, 2 info - the `notification/allOf[#/components/schemas/NotificationPushBase]/allOf[subschema #2]/inbox` response's property type/format changed from ``/`` to `boolean`/`` for status `200` - the `notification/allOf[#/components/schemas/NotificationPushBase]/allOf[subschema #2]/inboxTtl` response's property type/format changed from ``/`` to `number`/`` for status `200` - added the optional property `notification/allOf[#/components/schemas/NotificationPushBase]/allOf[subschema #2]/overrideSendingLimit` to the response with the `200` status - the `inbox` response's property default value `true` was added for the status `200` - …earlier changes not shown [Full history](https://skmtc.dev/notificare/apis/notificare-cloud-api/changes/notification/:id/get.md) --- [API](https://skmtc.dev/notificare/apis/notificare-cloud-api.md) · [All operations](https://skmtc.dev/notificare/apis/notificare-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/notificare/notificare-cloud-api/revisions/aad692b34bab/schema)