@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
• Installation
• Browsers support
• Usage
• Parameters for KintoneRest
• Helper functions
• Contribution Guide
• License

See the Migration Guide.

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";

[!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.

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

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.

The client supports three authentication methods:

1. Password authentication
2. API token authentication
3. OAuth authentication
4. Session authentication

Supported in browser environment only. If you omit auth parameter, the client uses Session authentication.

You can use the iterator to retrieve the API execution results efficiently. For detailed usage examples, please refer to https://github.com/kintone/js-sdk/blob/main/packages/rest/src/tests/helpers/iterator.test.ts.

See CONTRIBUTING.md for guidelines on how to contribute to this project.

• Apache 2.0