Kintone JavaScript API

Documents for JavaScript APIs for Kintone UI/UX manipulation.

Refer to the following article on how to use Kintone's event handlers:
Event Handling

Events

Record List Events

Triggered Timing Desktop Mobile
Onload Event app.record.index.show mobile.app.record.index.show
Inline Edit Event app.record.index.edit.show
Save Event app.record.index.edit.submit
Save Success Event app.record.index.edit.submit.success
Field Change Event app.record.index.edit.change.(fieldcode)
Delete Event app.record.index.delete.submit

Record Details Events

Triggered Timing Desktop Mobile
Onload Event app.record.detail.show mobile.app.record.detail.show
Delete Event app.record.detail.delete.submit mobile.app.record.detail.delete.submit
Update Status Event app.record.detail.process.proceed mobile.record.detail.process.proceed

Record Create Events

Triggered Timing Desktop Mobile
Onload Event app.record.create.show mobile.app.record.create.show
Save Event app.record.create.submit mobile.app.record.create.submit
Save Success Event app.record.create.submit.success mobile.app.record.create.submit.success
Field Change Event app.record.create.change.(fieldcode) mobile.app.record.create.change.(fieldcode)

Record Edit Events

Triggered Timing Desktop Mobile
Onload Event app.record.edit.show mobile.app.record.edit.show
Save Event app.record.edit.submit mobile.app.record.edit.submit
Save Success Event app.record.edit.submit.success mobile.app.record.edit.submit.success
Field Change Event app.record.edit.change.(fieldcode) mobile.app.record.edit.change.(fieldcode)

Record Print Events

Triggered Timing Desktop Mobile
Onload Event app.record.print.show

Graph Display Events

Triggered Timing Desktop Mobile
Onload Event app.report.show mobile.app.report.show

Portal Display Events

Triggered Timing Desktop Mobile
Onload Event portal.show mobile.portal.show

Space Display Events

Triggered Timing Desktop Mobile
Onload Event space.portal.show mobile.space.portal.show

Event Handling

API Desktop Mobile
Register Event Handlers kintone.events.on() kintone.events.on()
Delete a Handler kintone.events.off() kintone.events.off()

API Requests

Internal API Requests

API Desktop Mobile
Kintone REST API Request kintone.api() kintone.api()
Get URL kintone.api.url() kintone.api.url()
Get URL with Query kintone.api.urlForGet() kintone.api.urlForGet()
Get CSRF Token kintone.getRequestToken() kintone.getRequestToken()
Get Concurrency Limit kintone.api.getConcurrencyLimit() kintone.api.getConcurrencyLimit()

External API Requests

API Desktop Mobile
Proxy Request kintone.proxy() kintone.proxy()
Proxy File Upload kintone.proxy.upload() kintone.proxy.upload()

Get/Set Data

Records

API Desktop Mobile
Get Record ID kintone.app.record.getId() kintone.mobile.app.record.getId()
Get Record Details kintone.app.record.get() kintone.mobile.app.record.get()
Set Record Value kintone.app.record.set() kintone.mobile.app.record.set()
Get User's Record Permissions kintone.app.record.getPermissions() kintone.app.record.getPermissions()
Get User's Record Field Permissions kintone.app.record.getFieldPermissions() kintone.app.record.getFieldPermissions()
Get Record Status History kintone.app.record.getStatusHistory() kintone.app.record.getStatusHistory()

Apps

API Desktop Mobile
Get App kintone.app.get() kintone.app.get()
Get App ID kintone.app.getId() kintone.mobile.app.getId()
Get Form Fields kintone.app.getFormFields() kintone.app.getFormFields()
Get Form Layout kintone.app.getFormLayout() kintone.app.getFormLayout()
Check App Test Environment kintone.app.isTestEnvironment() kintone.app.isTestEnvironment()
Check App Maintenance Mode kintone.app.isMaintenanceMode() kintone.app.isMaintenanceMode()
Toggle App Description kintone.app.showDescription(state)
Get App Icon URLs kintone.app.getIcons() kintone.app.getIcons()
Get Record List Field Elements kintone.app.getFieldElements(fieldCode) kintone.mobile.app.getFieldElements(fieldCode)
Get Record List Header Menu Element kintone.app.getHeaderMenuSpaceElement()
Get Record List Header Element kintone.app.getHeaderSpaceElement()
Get View Settings kintone.app.getView() kintone.app.getView()
Get List of Views kintone.app.getViews() kintone.app.getViews()
Get Record List Query kintone.app.getQueryCondition() kintone.mobile.app.getQueryCondition()
Get Record List Query (with order by, limit, offset) kintone.app.getQuery() kintone.mobile.app.getQuery()
Get Mobile Header Element kintone.mobile.app.getHeaderSpaceElement()
Get Lookup Target kintone.app.getLookupTargetAppId() kintone.mobile.app.getLookupTargetAppId()
Get Related Records Target kintone.app.getRelatedRecordsTargetAppId() kintone.app.getRelatedRecordsTargetAppId()
Get Process Management Settings kintone.app.getStatus() kintone.app.getStatus()
Get Available Actions kintone.app.record.getStatusActions() kintone.app.record.getStatusActions()
Get Assignees kintone.app.record.getAssignees() kintone.app.record.getAssignees()
Get Categories kintone.app.getCategories() kintone.app.getCategories()
Get User's App Permissions kintone.app.getPermissions() kintone.app.getPermissions()

Space

API Desktop Mobile
Get Space Information kintone.space.get() kintone.space.get()
Get User's Space Permissions kintone.space.getPermissions() kintone.space.getPermissions()

System

API Desktop Mobile
Get Available Features kintone.system.getAvailableFeatures() kintone.system.getAvailableFeatures()
Get System Permissions kintone.system.getPermissions() kintone.system.getPermissions()

License

API Desktop Mobile
Check Trial Mode kintone.license.isTrial() kintone.license.isTrial()

General

API Desktop Mobile
Get Logged-in User kintone.getLoginUser() kintone.getLoginUser()
Get User Custom Fields kintone.user.getCustomFields() kintone.user.getCustomFields()
Get User Groups kintone.user.getGroups() kintone.user.getGroups()
Get User Departments kintone.user.getOrganizations() kintone.user.getOrganizations()
Get Page Type kintone.user.getPageType() kintone.user.getPageType()
Get User Icons kintone.user.getIcons() kintone.user.getIcons()
Get Design kintone.getUiVersion() kintone.getUiVersion()
Get Available Services kintone.getAvailableServices() kintone.getAvailableServices()
Get Domain Information kintone.getDomain() kintone.getDomain()
Get Available API Types kintone.getAvailableApiTypes() kintone.getAvailableApiTypes()
Check Client Certificate kintone.isAccessWithClientCertificateAuthentication() kintone.isAccessWithClientCertificateAuthentication()
Check Mobile App kintone.isMobileApp() kintone.isMobileApp()
Check Mobile Page kintone.isMobilePage() kintone.isMobilePage()
Get User Preference kintone.getUserPreference() kintone.getUserPreference()
Check User & System Administrator kintone.isUsersAndSystemAdministrator() kintone.isUsersAndSystemAdministrator()
Check Revamped UI kintone.isRevampedUI() kintone.isRevampedUI()
Display Confirmation Dialog kintone.showConfirmDialog()
Create Dialog kintone.createDialog()
Display Notification Message kintone.showNotification()
Toggle Loading UI kintone.showLoading()
Generate page URL kintone.buildPageUrl() kintone.buildPageUrl()
Set Keyboard Shortcuts kintone.setKeyboardShortcuts()

Field Visibility

API Desktop Mobile
Toggle Field Visibility kintone.app.record.setFieldShown() kintone.mobile.app.record.setFieldShown()
Open Field Group kintone.app.record.setGroupFieldOpen() kintone.mobile.app.record.setGroupFieldOpen()
Check Field Visibility kintone.app.record.isFieldVisible() kintone.mobile.app.record.isFieldVisible()
Check Group Field Status kintone.app.record.isGroupFieldOpen() kintone.mobile.app.record.isGroupFieldOpen()

Show/Hide App UI Elements

API Desktop Mobile
Toggle App Description kintone.app.showDescription()
Toggle New Record Button Visibility kintone.app.showAddRecordButton() kintone.mobile.app.showAddRecordButton()
Toggle App Settings Button Visibility kintone.app.showAppSettingsButton()
Toggle Duplicate Record Button Visibility kintone.app.record.showDuplicateRecordButton()
Toggle Edit Record Button Visibility kintone.app.record.showEditRecordButton() kintone.mobile.app.record.showEditRecordButton()
Toggle Filter Button Visibility kintone.app.showFilterButton() kintone.mobile.app.showFilterButton()
Toggle Graphs Selection Visibility kintone.app.showViewAndReportSelector() kintone.mobile.app.showReportSelector()
Toggle Views Selection Visibility kintone.app.showViewAndReportSelector() kintone.mobile.app.showViewSelector()
Toggle Options Button Visibility kintone.app.showOptionsButton() kintone.mobile.app.showOptionsButton()
Toggle Record Navigation Buttons Visibility kintone.app.record.showPager() kintone.mobile.app.record.showPager()
Toggle Graph Button Visibility kintone.app.showReportButton()
Toggle Sidebar kintone.app.record.showSideBar()

Get Element Display State

API Desktop Mobile
Get App Description Display State kintone.app.getDescriptionDisplayState()
Get Sidebar Display State kintone.app.record.getSideBarDisplayState()
Get New Record Button Display State kintone.app.getAddRecordButtonDisplayState() kintone.mobile.app.getAddRecordButtonDisplayState()
Get Edit Record Button Display State kintone.app.record.getEditRecordButtonDisplayState() kintone.mobile.app.record.getEditRecordButtonDisplayState()
Get Duplicate Record Button Display State kintone.app.record.getDuplicateRecordButtonDisplayState()
Get App Settings Button Display State kintone.app.getAppSettingsButtonDisplayState()
Get Options Button Display State kintone.app.getOptionsButtonDisplayState() kintone.mobile.app.getOptionsButtonDisplayState()
Get Record Navigation Buttons Display State kintone.app.record.getPagerDisplayState() kintone.mobile.app.record.getPagerDisplayState()
Get Filter Button Display State kintone.app.getFilterButtonDisplayState() kintone.mobile.app.getFilterButtonDisplayState()
Get Report Button Display State kintone.app.getReportButtonDisplayState()
Get Graphs Selection Display State kintone.app.getViewAndReportSelectorDisplayState() kintone.mobile.app.getReportSelectorDisplayState()
Get Views Selection Display State kintone.app.getViewAndReportSelectorDisplayState() kintone.mobile.app.getViewSelectorDisplayState()

Get Elements

Record Details

API Desktop Mobile
Get Record Field Element kintone.app.record.getFieldElement() kintone.mobile.app.record.getFieldElement()
Get Record Header Menu Element kintone.app.record.getHeaderMenuSpaceElement()
Get Mobile Header Element kintone.mobile.app.getHeaderSpaceElement()
Get Space Element kintone.app.record.getSpaceElement() kintone.mobile.app.record.getSpaceElement()

Record List

API Desktop Mobile
Get Record List Field Elements kintone.app.getFieldElements() kintone.mobile.app.getFieldElements()
Get Record List Header Menu Element kintone.app.getHeaderMenuSpaceElement()
Get Record List Header Element kintone.app.getHeaderSpaceElement()
Get Mobile Header Element kintone.mobile.app.getHeaderSpaceElement()

Portal

API Desktop Mobile
Get Portal kintone.portal.getContentSpaceElement() kintone.mobile.portal.getContentSpaceElement()

Space

API Desktop Mobile
Get Space Element kintone.space.portal.getContentSpaceElement() kintone.mobile.space.portal.getContentSpaceElement()

Plug-in

API Desktop Mobile
Get Config kintone.plugin.app.getConfig() kintone.plugin.app.getConfig()
Set Config kintone.plugin.app.setConfig()
Proxy Set Config kintone.plugin.app.setProxyConfig()
Proxy Get Config kintone.plugin.app.getProxyConfig()
Plug-in Proxy Request kintone.plugin.app.proxy() kintone.plugin.app.proxy()
Plug-in Proxy File kintone.plugin.app.proxy.upload() kintone.plugin.app.proxy.upload()