Skip to main content
Kintone is a cloud-based platform for building business applications. You can extend it in two ways: write JavaScript customizations that run inside the Kintone UI, or integrate external systems via the REST API.

JS API customization

Run JavaScript inside Kintone to respond to UI events, manipulate records, and customize the experience for users.

REST API integration

Call Kintone from any external system to read and write records, manage apps, and automate workflows.

​
JS API: customize Kintone with JavaScript

JS API customizations are JavaScript files you upload directly to a Kintone app. They run in the browser and have access to the kintone global object.
1

Open your app's settings

In Kintone, open the app you want to customize. Click the Settings gear icon, then go to Customize/Service Connect under the Customize section.
2

Create your customization file

Create a JavaScript file locally. The following example registers an event handler that fires when the record list page loads. Record data is available on event.records.
kintone.events.on('app.record.index.show', function(event) {
  console.log(event);
  // Displays contents of event object in console
  // Record data is contained in event.records
});
3

Upload and save

Upload your .js file on the JavaScript and CSS Customization settings page. Click Save, then Update App to deploy the changes.
4

Open the record list

Navigate to the record list in your app. Open the browser developer console — you should see the event object logged, including appId, viewId, viewType, and an array of records.
The kintone.events.on() function is only available inside Kintone customization scripts running in the browser. See Event Handling for the full list of supported events.

​
REST API: integrate from external systems

The Kintone REST API lets you read and write data from any HTTP client. All requests go to your subdomain at https://{subdomain}.kintone.com.
1

Get your credentials

You need a Kintone login and password (or an API token — see Authentication). Note your subdomain and the App ID of the app you want to access. The App ID appears in the URL when you open the app: https://{subdomain}.kintone.com/k/{appId}/.
2

Encode your credentials

Password authentication uses a Base64-encoded login:password string sent in the X-Cybozu-Authorization header.
echo -n 'your-login:your-password' | base64
3

Fetch records

Use the Get Records endpoint to retrieve records from an app. Replace {subdomain}, {AuthorizationCode}, and {appId} with your values.
curl -X GET 'https://{subdomain}.kintone.com/k/v1/records.json?app={appId}' \
  -H 'X-Cybozu-Authorization: {AuthorizationCode}' \
  -H 'Content-Type: application/json'
A successful response returns a JSON object with a records array and a totalCount field.
{
  "records": [
    {
      "$id": { "type": "__ID__", "value": "1" },
      "$revision": { "type": "__REVISION__", "value": "1" }
    }
  ],
  "totalCount": "1"
}
The REST API base URL uses /k/v1/ for standard apps. Guest space apps use /k/guest/{spaceId}/v1/. See REST API Overview for the full endpoint list.

​
Next steps

Authentication

Learn about password auth, API tokens, and session auth.

JS API overview

Explore the full JavaScript API surface.

REST API overview

Browse all REST endpoints for records, apps, and spaces.

Event handling

Handle record list, detail, create, and edit events.

Build docs developers (and LLMs) love

Get started for freeTalk to us