Get Customization

Gets the JavaScript and CSS Customization settings of an App.
Method GET
URL https://{subdomain}.kintone.com/k/v1/app/customize.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/customize.json
Authentication Password Authentication

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

Permissions

  • Permission to manage the app is needed when obtaining data of live apps.
  • Permission to manage the app is needed when obtaining data of pre-live settings.
  • API Tokens cannot be used with this API.

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
desktop Object An object containing data of JavaScript and CSS files for the desktop.
desktop.css Array An array listing data of CSS files.
desktop.css[].file Object An Object containing data of an uploaded CSS file.
desktop.css[].file.contentType String The MIME type of the uploaded CSS file.
desktop.css[].file.fileKey String The fileKey of the uploaded CSS file.
desktop.css[].file.name String The file name of the uploaded CSS file.
desktop.css[].file.size String The byte size of the uploaded CSS file.
desktop.css[].type String The end-point type of the CSS file:
  • URL: the CSS file is specified with a URL.
  • FILE: the CSS file is uploaded to the app.
desktop.css[].url String The URL of the CSS file.
desktop.js Array An array listing data of JavaScript files.
desktop.js[].file Object An Object containing data of an uploaded JavaScript file.
desktop.js[].file.contentType String The MIME type of the uploaded JavaScript file.
desktop.js[].file.fileKey String The fileKey of the uploaded JavaScript file.
desktop.js[].file.name String The file name of the uploaded JavaScript file.
desktop.js[].file.size String The byte size of the uploaded JavaScript file.
desktop.js[].type String The end-point type of the JavaScript file:
  • URL: the JavaScript file is specified with a URL.
  • FILE: the JavaScript file is uploaded to the app.
desktop.js[].url String The URL of the JavaScript file.
mobile Object An object containing data of JavaScript files for the mobile.
mobile.js Array An array listing data of JavaScript files.
mobile.js[].file Object An Object containing data of an uploaded JavaScript file.
mobile.js[].file.contentType String The MIME type of the uploaded JavaScript file.
mobile.js[].file.fileKey String The fileKey of the uploaded JavaScript file.
mobile.js[].file.name String The file name of the uploaded JavaScript file.
mobile.js[].file.size String The byte size of the uploaded JavaScript file.
mobile.js[].type String The end-point type of the JavaScript file:
  • URL: the JavaScript file is specified with a URL.
  • FILE: the JavaScript file is uploaded to the app.
mobile.js[].url String The URL of the JavaScript file.
revision String The revision number of the app settings.
scope String The scope of customization
  • ALL: Affect all users
  • ADMIN: Affect only app administrators
  • NONE: Disable

Sample Response

Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.