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

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.
  • API Tokens cannot be used with this API.

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)

XMLHttpRequest

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

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