@kintone/rest NPM

@kintone/rest

@kintone/rest is a client library for accessing the kintone REST API from JavaScript or TypeScript applications.
It is automatically generated using openapi-typescript.

Migration

See the Migration Guide.

Installation

1. Install with npm

Install the package via npm:

npm install @kintone/rest

Once installed, the library can be imported using either require or import:

// CommonJS
const { createClient } = require("@kintone/rest");
// ES modules
import { createClient } from "@kintone/rest";

2. Load UMD files from CDN (for browser environment)

!IMPORTANT To avoid cascading failures from the CDN, we recommend using the npm package and bundling it to your plugin/customization.

You can also load Universal Module Definition (UMD) files directly from Cybozu CDN:

https://cybozu.dev/ja/kintone/sdk/library/cybozu-cdn/#kintone-rest

Regarding restrictions and availability, please check Cybozu CDN Policy:

https://cybozu.dev/ja/policy/cybozu-cdn-policy/

After loading the UMD file, you can use KintoneRest in your environment. In Kintone customization, please add the UMD file URL in the "JavaScript and CSS Customization" setting of your app.

Browsers support

Edge	Firefox	Chrome	Safari
Latest version	Latest version	Latest version	Latest version

Usage

Here's an example of how to retrieve records from a kintone app using TypeScript:

import { createClient } from "@kintone/rest";

const client = createClient({
  baseUrl: "https://example.cybozu.com",
  auth: {
    type: "password",
    username: process.env.KINTONE_USERNAME,
    password: process.env.KINTONE_PASSWORD,
  },
  // Use API token authentication
  // auth: {
  //   type: "apiToken",
  //   apiToken: process.env.KINTONE_API_TOKEN,
  // }
  // Use OAuth token authentication
  // auth: {
  //   type: "oauth",
  //   oAuthToken: process.env.KINTONE_OAUTH_TOKEN,
  // }
});

try {
  const resp = await client.request("get", "/k/v1/records.json", {
    params: {
      query: { app: 1 },
    },
  });
  console.log(resp.data?.records);
} catch (e) {
  console.error(e);
}

We recommend using TypeScript to take advantage of features like path and parameter autocompletion. If you're using JavaScript, you can still create the client using the same code, though without those benefits.

Parameters for `KintoneRest`

Name	Type	Required	Description
baseUrl	String	ConditionallyRequired	The base URL for your Kintone environment.It must start with `https`. (e.g. https://example.kintone.com) Required in Node.js environment. If you omit it in browser environment, `location.origin` will be used.The protocol of baseUrl must be `https` except when hostname is `localhost`.
auth	Object	ConditionallyRequired	The object for authentication. See Authentication.
basicAuth	Object		If your Kintone environment uses Basic authentication, please specify its username and password.
basicAuth.username	String		The username of Basic authentication.
basicAuth.password	String		The password of Basic authentication.
httpsAgent	Object		This parameter is available only in Node.js environment.The custom HTTPS agent to be used when making requests.The agent should be compatible with undici.Agent.
clientCertAuth	Object		This parameter is available only in Node.js environment.When `httpsAgent` parameter is given, this parameter is unavailable.If your Kintone environment uses Client Certificate authentication, please specify the certificate file and password.
clientCertAuth.pfx	Buffer		The client certificate file. Required, unless you specify `pfxFilePath`.
clientCertAuth.pfxFilePath	String		The path to client certificate file. Required, unless you specify `pfx`.
clientCertAuth.password	String		The password of client certificate.
proxy	Object		This parameter is available only in Node.js environment.If you use a proxy, please specify its configuration.
proxy.protocol	String		The protocol of the proxy server. Default is `http`.
proxy.host	String		The host of the proxy server.
proxy.port	Number		The port of the proxy server.
proxy.auth	Object		If the proxy server requires Basic authentication, please specify its username and password.
proxy.auth.username	String		The username of Basic authentication for the proxy server.
proxy.auth.password	String		The password of Basic authentication for the proxy server.
userAgent	String		This parameter is available only in Node.js environment.A User-Agent HTTP header
socketTimeout	Number		This parameter is available only in Node.js environment.The socket timeout in milliseconds.