Get General Settings

Gets the description, name, icon, revision and color theme of an App.

Method	GET
URL	https://{subdomain}.kintone.com/k/v1/app/settings.json
URL(guest space)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/settings.json
Authentication	Password Authentication, API Token Authentication, Session Authentication
Content-Type	application/json (not needed if specifying the query with a query string)

Pre-live settings
Permissions
Request Parameters
Sample Request
Response Parameters
Sample Response

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/settings.json
URL(guest space)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/settings.json

Permissions

Permission to view records are needed when obtaining data of live apps.
App Management Permissions are needed when obtaining data of pre-live settings.

Request Parameters

Parameter	Value	Required	Description
app	Integer or String	Required	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': 1,
  'lang': 'en'
};

kintone.api(kintone.api.url('/k/v1/app/settings.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


var params = '?app=1&lang=en';
var url = 'https://{subdomain}.kintone.com/k/v1/app/settings.json' + params;
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
description	String	The app description in HTML format.
icon	Object	An object containing data of the App icon.
icon.file	Object	An object containing data of uploaded icon files.
icon.file.contentType	String	The MIME type of the uploaded icon file.
icon.file.fileKey	String	The fileKey of the uploaded icon file.
icon.file.name	String	The file name of the uploaded icon file.
icon.file.size	String	The byte size of the uploaded icon file.
icon.key	String	The key identifier of the icon. Responded, if the preset icons within Kintone are used.
icon.type	String	The icon type: FILE: An uploaded image. PRESET: A preset icon within Kintone.
name	String	The App name.
revision	String	The revision number of the App settings.
theme	String	The color theme. WHITE RED BLUE GREEN YELLOW BLACK Apps created before February 2017 may respond with the following classic themes:CLIPBOARD, BINDER, PENCIL, CLIPS.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "name": "San Francisco Lunch Map",
  "description": "A list of great places to go!",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
  "revision": "24"
}

API Docs