Gets the Per Record Notification settings of the App.
| Method | GET |
| URL | https://{subdomain}.kintone.com/k/v1/app/notifications/perRecord.json |
| URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/notifications/perRecord.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/perRecord.json |
| URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/notifications/perRecord.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 containing data of the Per Record Notification settings. |
| notifications[].filterCond | String | The record's filter condition in query string format. For more information, refer to the Sample Requests (Query String) section. |
| notifications[].title | String | The notification subject that is saved under "Summary". |
| notifications[].targets | Array | An array of objects containing the recipients of the Per Record Notification. |
| notifications[].targets[].entity | Object | An object containing entity details per recipient of the Per Record Notification. |
| notifications[].targets[].entity.type | String | The type of the entity the Per Record Notification settings are configured to.
|
| notifications[].targets[].entity.code | String | The code of the entity the Per Record Notification settings are configured to. The following entities will return the following values:
|
| 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 Per Record Notification settings false : Affiliated departments do not inherit the Per Record Notification settings |
| revision | String | The revision number of the App settings. |
Sample Response