Kintone JavaScript API

Documents for JavaScript APIs for Kintone UI/UX manipulation.

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

Event Handling

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

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)

Graph Display Events

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

Record Print Events

Triggered Timing Desktop Mobile
Onload Event app.record.print.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

Users

API Desktop Mobile
Get Logged-in User kintone.getLoginUser() kintone.getLoginUser()
Get Design kintone.getUiVersion() kintone.getUiVersion()

Apps

API Desktop Mobile
Get App ID kintone.app.getId() kintone.mobile.app.getId()
Get Record List Query kintone.app.getQueryCondition() kintone.mobile.app.getQueryCondition()
Get Lookup Target kintone.app.getLookupTargetAppId() kintone.mobile.app.getLookupTargetAppId()
Get Mobile Header Element kintone.mobile.app.getHeaderSpaceElement()
Get Record List Field Elements kintone.app.getFieldElements() kintone.mobile.app.getFieldElements()
Get Record List Header Element kintone.app.getHeaderSpaceElement()
Get Record List Header Menu Element kintone.app.getHeaderMenuSpaceElement()
Get Record List Query (with order by, limit, offset) kintone.app.getQuery() kintone.mobile.app.getQuery()
Get Related Records Target kintone.app.getRelatedRecordsTargetAppId()

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()
Get Record Field Element kintone.app.record.getFieldElement() kintone.mobile.app.record.getFieldElement()
Set Record Value kintone.app.record.set() kintone.mobile.app.record.set()
Get Record Header Menu Element kintone.app.record.getHeaderMenuSpaceElement()
Get Space Element kintone.app.record.getSpaceElement() kintone.mobile.app.record.getSpaceElement()
Open Field Group kintone.app.record.setGroupFieldOpen() kintone.mobile.app.record.setGroupFieldOpen()
Toggle Field Visibility kintone.app.record.setFieldShown() kintone.mobile.app.record.setFieldShown()

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()

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
Set Config kintone.plugin.app.setConfig()
Get Config kintone.plugin.app.getConfig() kintone.plugin.app.getConfig()
Plug-in Proxy Request kintone.plugin.app.proxy() kintone.plugin.app.proxy()
Proxy Set Config kintone.plugin.app.setProxyConfig()
Proxy Get Config kintone.plugin.app.getProxyConfig()
Plug-in Proxy File kintone.plugin.app.proxy.upload() kintone.plugin.app.proxy.upload()