Get General Notification Settings

Gets the General Notification settings of the App.
Method GET
URL https://{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 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/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 Value Required Description
app Integer or String Yes The App ID.

Sample Request

JavaScript (using Kintone REST API Request)

XMLHttpRequest

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

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!