Get Reminder Notification Settings

Gets the Reminder Notification settings of the App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app/notifications/reminder.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/reminder.json
AuthenticationAPI Token Authentication , Password Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

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:
- default: retrieves the default names
- en: retrieves the localized English names
- zh: retrieves the localized Chinese names
- ja: retrieves the localized Japanese names
- user: retrieves the localized names in the same language as the language setting* set on the user used for the authentication.
If ignored, the default names will be retrieved.

*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

JavaScript (using Kintone REST API Request )

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
var body = {
  'app': kintone.app.getId(),
  'lang': 'en'
};

kintone.api(kintone.api.url('/k/v1/app/notifications/reminder', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
var appId = kintone.app.getId();
var url = 'https://{subdomain}.kintone.com/k/v1/app/notifications/reminder.json?app=' + appId + '&lang=en';

var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

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.
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.
- USER: User
- GROUP: Group
- ORGANIZATION: Department
- FIELD_ENTITY: Created By, Updated By, User Selection, Group Selection, and Department Selection Fields
notifications[].targets[].entity.code String The code of the entity the Reminder Notification settings are configured to.
- FIELD_ENTITY: The field code of the field
- For all other entities: The code of the User, Group, or DepartmentFor guest users, the login name is preceded by guest/.
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "notifications": [
    {
      "timing": {
        "code": "Deadline_Date",
        "daysLater": "-1",
        "time": "09:00"
      },
      "filterCond": "User_selection in (\" USER\", \"user1\")",
      "title": "Reminder: Tomorrow is the deadline",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "timing": {
        "code": "Created_datetime",
        "daysLater": "1",
        "hoursLater": "2"
      },
      "filterCond": "User_selection in (\" USER\", \"user1\")",
      "title": "Reminder: Yesterday's records",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "timezone": "America/Los_Angeles",
  "revision": "2"
}