API Docs

Get General Notification Settings

Gets the General Notification (External link) settings of the App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app/notifications/general.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/general.json
Authentication Password Authentication , API Token Authentication , Session 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/general.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/general.json

Permissions

  • App Management Permissions are needed.

Request Parameters

Parameter Type Required Description
app Integer or String Yes The App ID.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'app': kintone.app.getId()
};

kintone.api(kintone.api.url('/k/v1/app/notifications/general.json', 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
17

var appId = kintone.app.getId();
var url = 'https://{subdomain}.kintone.com/k/v1/app/notifications/general.json?app=' + appId;
console.log(url);

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 "Recipients and Conditions" options. These options define who will receive the notifications.
notifications[].entity Object An object containing data of the entity the General Notification settings are configured to.
notifications[].entity.type String The type of the entity the General 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[].entity.code String The code of the entity the General Notification settings are configured to. The following entities will return the following values:
  • FIELD_ENTITY: The field code of the field
  • For all other entities: The code of the User, Group, or Department
For guest users, the login name is preceded by guest/.
notifications[].includeSubs Boolean The "Include affiliated departments" setting of the Department.
Will always return false unless the notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection Field.
  • true: Affiliated departments do inherit the General Notification settings
  • false: Affiliated departments do not inherit the General Notification settings
notifications[].recordAdded Boolean Option to notify the entity when a record is added.
  • true: Notify when a record is added
  • false: Do not notify when a record is added
notifications[].recordEdited Boolean Option to notify the entity when a record is edited.
  • true: Notify when a record is edited
  • false: Do not notify when a record is edited
notifications[].commentAdded Boolean Option to notify the entity when a comment is posted.
  • true: Notify when a comment is posted
  • false: Do not notify when a comment is posted
notifications[].statusChanged Boolean Option to notify the entity when a status is changed.
  • true: Notify when a status is changed
  • false: Do not notify when a status is changed
notifications[].fileImported Boolean Option to notify the entity when a file is imported.
  • true: Notify when a file is imported
  • false: Do not notify when a file is imported
notifyToCommenter Boolean Option to notify all commenters of a record when a comment is posted on that record. This reflects the "Send updated comment notifications to all commenters" checkbox.
  • true: Notify all commenters of the record when a comment is posted
  • false: Do not notify all commenters of the record when a comment is posted
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

{
  "notifications": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "includeSubs": false,
      "recordAdded": true,
      "recordEdited": true,
      "commentAdded": false,
      "statusChanged": false,
      "fileImported": true
    }
  ],
  "notifyToCommenter": true,
  "revision": "2"
}