Use this file to discover all available pages before exploring further.
The Kintone JavaScript API lets you customize the behavior and appearance of Kintone apps directly in the browser. You can register event handlers that run when users load pages, create or edit records, or interact with fields — and you can read and write field values, show or hide UI elements, and call the Kintone REST API or external APIs from within your customization code.
You add JavaScript customizations to an app through the app’s JavaScript and CSS customization settings. Paste your script file URL or upload a .js file, then save and activate the app. Kintone loads your script on every page where the app is displayed.Always wrap your customization code in an immediately-invoked function expression (IIFE) to avoid polluting the global namespace and to ensure event handlers are registered at the correct time:
(function() { 'use strict'; kintone.events.on('app.record.index.show', function(event) { // Your customization logic here return event; });})();
Register event handlers synchronously when your script loads — not inside DOMContentLoaded or load event callbacks. See Event handling for details on why this matters.
Register and remove handlers for record list, detail, create, edit, print, graph, portal, and space events. Use kintone.events.on() and kintone.events.off().
Record APIs
Get and set record data, field values, and permissions. Access the current record ID and field elements on the page.
App APIs
Retrieve app metadata, form fields and layout, views, query conditions, and UI element references such as the header menu space element.
Space APIs
Get space information and space permissions for the current space context.
System APIs
Check available platform features and system-level permissions.
Field visibility
Show or hide fields and field groups on record forms programmatically.
UI elements
Toggle visibility of UI controls such as the new record button, filter button, edit button, sidebar, and status action buttons.
General utilities
Get the logged-in user, user groups, organizations, design version, available services, and domain. Display notifications, confirmation dialogs, and loading indicators.
Plug-in APIs
Read and write plug-in configuration. Make authenticated proxy requests to external services using plug-in credentials.
