Gets the Reminder Notification settings of the App.
| Method | GET |
| URL | https://{subdomain}.kintone.com/k/v1/app/notifications/reminder.json |
| URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/reminder.json |
| Authentication | API Token Authentication , Password Authentication |
| Content-Type | application/json (not needed if specifying the query with a query string) |
Pre-live settings
Apps may hold pre-live settings that have not yet been deployed to the live app.
Access the pre-live settings with the below URL.
| URL | https://{subdomain}.kintone.com/k/v1/preview/app/notifications/reminder.json |
| URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/reminder.json |
Permissions
- App Management Permissions are needed.
Request Parameters
| Parameter | Value | Required | Description |
|---|---|---|---|
| app | Integer or String | Yes | The App ID. |
| lang | String | The localized language to retrieve the data in:
|
*If the user language setting is set to "Use Web browser settings", the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the "Localization" settings in the System Administrator's menu will be used.
Sample Request
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| notifications | Array | An array of objects consisting of "Notification Trigger" options. These options define when the notifications will be sent out, under what conditions, and the recipients. The objects are in chronological order, with the newest first. |
| notifications[].timing | Object | An object containing the Reminder notification's timing. |
| notifications[].timing.code | String | The field code of the field used to determine the Reminder notification's timing. |
| notifications[].timing.daysLater | String | The number of days after the notifications[].timing.code date/datetime when the Reminder notification is sent. A negative value indicates the number of days before the notifications[].timing.code date/datetime. |
| notifications[].timing.hoursLater | String | The number of hours after the notifications[].timing.code datetime, shifted by daysLater, when the Reminder notification is sent. A negative value indicates the number of hours before the notifications[].timing.code datetime, shifted by daysLater. The parameter is returned only if the notifications[].timing.code parameter is set to a Date and Time field and the "When" hours before/after option is configured (instead of the "At" time option). |
| notifications[].timing.time | String | The time when the Reminder notification is sent. The parameter is returned if the notifications[].timing.code parameter is set to a date field or the "At" time option is configured. |
| notifications[].filterCond | String | The record's filter condition in query string format. For more information, refer to the Sample Requests (Query String) section. The request will fail if a deleted User, Group, or Organization is specified in the filter condition. |
| notifications[].title | String | The notification subject that is saved under "Summary". |
| notifications[].targets | Array | An array of objects containing the recipients of the Reminder Notification. |
| notifications[].targets[].entity | Object | An object containing entity details per recipient of the Reminder Notification. |
| notifications[].targets[].entity.type | String | The type of the entity the Reminder Notification settings are configured to.
|
| notifications[].targets[].entity.code | String | The code of the entity the Reminder Notification settings are configured to.
|
| notifications[].targets[].includeSubs | Boolean | The "Include affiliated departments" setting of the Department. Will always return false unless the notifications[].targets[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field. true : Affiliated departments do inherit the Reminder Notification settings false : Affiliated departments do not inherit the Reminder Notification settings |
| timezone | String | The timezone that determines the Reminder notification's timing. This reflects the "Reminder Time Zone" dropdown option. If the App's Reminder Notification settings have never been configured, null will be returned. |
| revision | String | The revision number of the App settings. |
Sample Response