# Kintone REST

```json
{
  "name": "Kintone REST",
  "slug": "kintone_rest",
  "url": "https://composio.dev/toolkits/kintone_rest",
  "markdown_url": "https://composio.dev/toolkits/kintone_rest.md",
  "logo_url": "https://logos.composio.dev/api/kintone_rest",
  "categories": [
    "productivity & project management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-09-25T05:33:24.738Z"
}
```

![Kintone REST logo](https://logos.composio.dev/api/kintone_rest)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Kintone REST MCP or direct API to read records, create and update records, query apps, and manage app settings through natural language.

## Summary

Kintone REST is Kintone's REST API for managing apps, records, and settings.
Use delegated OAuth to securely grant read and write access for integrations.

## Categories

- productivity & project management

## Toolkit Details

- Tools: 55

## Images

- Logo: https://logos.composio.dev/api/kintone_rest

## Authentication

- **Oauth2**
  - Type: `oauth2`
  - Description: Oauth2 authentication for Kintone REST.
  - Setup:
    - Configure Oauth2 credentials for Kintone REST.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- List all records in Sales app
- Create a new record in Leads app
- Update records matching status open in Sales

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `KINTONE_REST_ADD_COMMENT` | Add Comment | Add one comment to a Kintone record, optionally mentioning up to 10 users, groups, or organizations. The app's commenting feature must be enabled. |
| `KINTONE_REST_ADD_FORM_FIELDS` | Add Form Fields | Add typed fields to an app's pre-live form, including selections, lookups, related-record lists, groups, and nested tables. Deploy app settings separately to make them live. |
| `KINTONE_REST_ADD_PREVIEW_APP` | Add Preview App | Create a pre-live Kintone app and return its app ID and initial settings revision. Kintone provides no REST API to delete the created preview app, so this creation cannot be undone through the API. Deploy it separately when its settings are ready. |
| `KINTONE_REST_CREATE_RECORD` | Create Record | Create one record in a Kintone app from field-code values and return its record ID and revision. |
| `KINTONE_REST_CREATE_RECORDS` | Create Records | Create one to 100 records atomically in one Kintone app and return their record IDs and revisions in input order. |
| `KINTONE_REST_DELETE_COMMENT` | Delete Comment | Permanently delete one comment from a Kintone record. With OAuth user authentication, only a comment created by that user can be deleted. |
| `KINTONE_REST_DELETE_FORM_FIELDS` | Delete Form Fields | Delete up to 100 fields from an app's pre-live form. Deleting a group or table also deletes every field it contains. The deletion affects preview settings until deployed and returns the resulting revision. |
| `KINTONE_REST_DELETE_RECORDS` | Delete Records | Permanently delete one to 100 explicitly identified records from a Kintone app. If revisions are supplied, Kintone deletes no records when any revision does not match. |
| `KINTONE_REST_DEPLOY_APP_SETTINGS` | Deploy App Settings | Atomically apply the complete pre-live settings of up to 300 Kintone apps to their live apps. If one deployment fails, Kintone rolls every app in the request back to its pre-request state. |
| `KINTONE_REST_DISCARD_APP_SETTINGS_CHANGES` | Discard App Settings Changes | Permanently discard every pre-live settings change for up to 300 Kintone apps and restore each preview to its current live settings. This does not change the live apps. If one discard fails, Kintone rolls back the entire request. |
| `KINTONE_REST_DOWNLOAD_FILE` | Download File | Download an attachment up to 100 MB using the file key returned by a record read. Files larger than 100 MB are rejected. |
| `KINTONE_REST_GET_ACTION_SETTINGS` | Get Action Settings | Return deployed or unpublished record-copy action settings of an app, including destinations, mappings, availability, order, and revision. |
| `KINTONE_REST_GET_APP` | Get App | Gets general information of an App, including the name, description, related Space, creator and updater information. Use guest_space_id only when the target app belongs to a Kintone guest space. |
| `KINTONE_REST_GET_APP_DEPLOY_STATUS` | Get App Deploy Status | Get the deployment status of settings for up to 300 Kintone apps. |
| `KINTONE_REST_GET_APP_PERMISSIONS` | Get App Permissions | Return deployed or unpublished app-level permissions and settings revision in priority order. |
| `KINTONE_REST_GET_APP_SETTINGS` | Get App Settings | Return an app's deployed or unpublished name, description, title-field configuration, feature flags, theme, icon, and revision. |
| `KINTONE_REST_GET_CUSTOMIZATION` | Get Customization | Return deployed or unpublished desktop and mobile JavaScript and CSS customization files, scope, and revision for an app. |
| `KINTONE_REST_GET_FIELD_PERMISSIONS` | Get Field Permissions | Return deployed or unpublished field permissions, including prioritized subjects and each field's access level. |
| `KINTONE_REST_GET_FORM` | Get Form | Read a deployed or unpublished app form in Kintone's legacy property-array format. This reader omits Categories, Status, and Field Groups; inside Field Groups, it also omits system-generated fields, blank spaces, labels, and borders. Use GET_FORM_FIELDS for field definitions and settings keyed by field code, or GET_FORM_LAYOUT for row, group, table, and field-size layout data. |
| `KINTONE_REST_GET_FORM_FIELDS` | Get Form Fields | Return deployed or unpublished field codes, types, labels, and settings so an agent can construct valid record values and queries. |
| `KINTONE_REST_GET_FORM_LAYOUT` | Get Form Layout | Return deployed or unpublished field layout information for an app form, including rows, groups, tables, fields, and sizes. |
| `KINTONE_REST_GET_GENERAL_NOTIFICATION_SETTINGS` | Get General Notification Settings | Get an app's deployed or unpublished general-notification recipients, event conditions, commenter option, and revision. |
| `KINTONE_REST_GET_GRAPH_SETTINGS` | Get Graph Settings | Return deployed or unpublished graph definitions with their chart, aggregation, grouping, sorting, periodic-report settings, and revision. |
| `KINTONE_REST_GET_PER_RECORD_NOTIFICATION_SETTINGS` | Get Per Record Notification Settings | Get an app's deployed or unpublished conditional per-record notifications, recipients, subjects, and revision. |
| `KINTONE_REST_GET_PROCESS_MANAGEMENT_SETTINGS` | Get Process Management Settings | Return deployed or unpublished process-management enablement, statuses, assignee rules, transitions, branch conditions, and revision. |
| `KINTONE_REST_GET_RECORD` | Get Record | Retrieve one record from a Kintone app by its record ID. |
| `KINTONE_REST_GET_RECORD_PERMISSIONS` | Get Record Permissions | Return deployed or unpublished record permission rules, preserving each query filter and prioritized subject list. |
| `KINTONE_REST_GET_REMINDER_NOTIFICATION_SETTINGS` | Get Reminder Notification Settings | Get an app's deployed or unpublished reminder timing, filters, recipients, timezone, and revision. |
| `KINTONE_REST_GET_VIEWS` | Get Views | Return deployed or unpublished list, calendar, custom, and built-in view settings, including filters, sorting, displayed fields, and revision. |
| `KINTONE_REST_LIST_APPS` | List Apps | Find apps visible to the connected Kintone user by name, ID, code, or space and return one offset-controlled page of app metadata. |
| `KINTONE_REST_LIST_COMMENTS` | List Comments | Retrieve one offset-controlled page of up to 10 comments from a Kintone record. The app's commenting feature must be enabled. |
| `KINTONE_REST_SEARCH_RECORDS` | Search Records | Search an app's records with a Kintone query and return one offset-controlled page. OAuth searches cannot continue beyond offset 10,000. |
| `KINTONE_REST_UPDATE_ACTION_SETTINGS` | Update Action Settings | Replace the complete unpublished record-copy action map. Existing preview actions omitted from actions are deleted, so read preview action settings first and include every action to retain. Deploy app settings separately to make the replacement live. |
| `KINTONE_REST_UPDATE_APP_PERMISSIONS` | Update App Permissions | Replace app-level permissions in priority order and deploy all pending app settings, not only permissions. This can immediately revoke app or record access for omitted or restricted entities; read the current and preview settings first when preserving access. |
| `KINTONE_REST_UPDATE_ASSIGNEES` | Update Assignees | Replace the assignees of one Kintone record whose app uses Process Management. An empty assignee list removes all assignees; the caller needs app-management and record-view permissions. |
| `KINTONE_REST_UPDATE_CUSTOMIZATION` | Update Customization | Update unpublished desktop and mobile JavaScript and CSS customization. Deploy app settings separately to make changes live. |
| `KINTONE_REST_UPDATE_FIELD_PERMISSIONS` | Update Field Permissions | Replace field permissions and deploy all pending app settings, not only permissions. This can immediately revoke field access for omitted fields or entities and settings are applied to affected fields sequentially; read the current and preview settings first when preserving access. |
| `KINTONE_REST_UPDATE_FORM_FIELDS` | Update Form Fields | Update typed field settings in an app's pre-live form. Supplying options replaces that field's complete option set and deletes omitted options. Deploy app settings separately to make changes live. |
| `KINTONE_REST_UPDATE_FORM_LAYOUT` | Update Form Layout | Replace an app's complete pre-live form layout. Kintone requires every form field to be included in the request. Deploy app settings separately to make the layout live. |
| `KINTONE_REST_UPDATE_GENERAL_NOTIFICATION_SETTINGS` | Update General Notification Settings | Replace or selectively update an app's undeployed general-notification settings; deploy the app settings afterward to make them live. |
| `KINTONE_REST_UPDATE_GENERAL_SETTINGS` | Update General Settings | Update unpublished general app settings such as name, description, icon, theme, feature flags, title field, and number precision. Deploy separately. |
| `KINTONE_REST_UPDATE_GRAPH_SETTINGS` | Update Graph Settings | Replace the complete unpublished graph map. Existing preview graphs omitted from reports are deleted, so read preview graph settings first and include every graph to retain. Deploy app settings separately to make the replacement live. |
| `KINTONE_REST_UPDATE_PER_RECORD_NOTIFICATION_SETTINGS` | Update Per Record Notification Settings | Replace an app's undeployed per-record notification rules; deploy the app settings afterward to make them live. |
| `KINTONE_REST_UPDATE_PREVIEW_APP_PERMISSIONS` | Update Preview App Permissions | Replace the complete unpublished app-level permission list in priority order without deploying it. Omitted or restricted entities may lose access when the preview settings are later deployed; read preview permissions first when preserving access. |
| `KINTONE_REST_UPDATE_PREVIEW_FIELD_PERMISSIONS` | Update Preview Field Permissions | Replace the complete unpublished field permission list without deploying it. Omitted fields or entities may lose access when the preview settings are later deployed; read preview field permissions first when preserving access. |
| `KINTONE_REST_UPDATE_PREVIEW_RECORD_PERMISSIONS` | Update Preview Record Permissions | Replace the complete unpublished record permission rule list without deploying it. Omitted or restricted rules may revoke record access when the preview settings are later deployed; read preview record permissions first when preserving access. |
| `KINTONE_REST_UPDATE_PROCESS_MANAGEMENT_SETTINGS` | Update Process Management Settings | Update unpublished process-management settings. When states is supplied it is the complete desired preview status map: omitted statuses are deleted, so read preview process settings first and include every status to retain. Deploy app settings separately. |
| `KINTONE_REST_UPDATE_RECORD` | Update Record | Update selected fields of one Kintone record by record ID, optionally requiring an expected revision. |
| `KINTONE_REST_UPDATE_RECORD_PERMISSIONS` | Update Record Permissions | Replace record permission rules and deploy all pending app settings, not only permissions. This can immediately revoke record access for omitted or restricted rules and settings are applied to affected records sequentially; read the current and preview settings first when preserving access. |
| `KINTONE_REST_UPDATE_RECORDS` | Update Records | Update selected fields of one to 100 Kintone records atomically by record ID, optionally checking each revision. This tool does not select by unique key and never upserts. |
| `KINTONE_REST_UPDATE_REMINDER_NOTIFICATION_SETTINGS` | Update Reminder Notification Settings | Replace or selectively update an app's undeployed reminder rules and timezone; deploy the app settings afterward to make them live. |
| `KINTONE_REST_UPDATE_STATUS` | Update Status | Run one Process Management action to update a Kintone record's workflow status, optionally selecting the next assignee and checking the current revision. |
| `KINTONE_REST_UPDATE_STATUSES` | Update Statuses | Run Process Management actions for one to 100 Kintone records in the same app, optionally selecting assignees and checking revisions. |
| `KINTONE_REST_UPDATE_VIEWS` | Update Views | Replace the complete unpublished list, calendar, and custom view map. Existing preview views omitted from views are deleted, so read preview views first and include every view to retain. Deploy app settings separately to make the replacement live. |
| `KINTONE_REST_UPLOAD_FILE` | Upload File | Upload one managed file to Kintone and return the temporary file key used to attach it to a record within three days. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Kintone REST Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Kintone REST actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'YOUR_SPECIFIC_PROMPT_HERE'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'YOUR_SPECIFIC_PROMPT_HERE'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Kintone REST
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Kintone REST tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('YOUR_SPECIFIC_PROMPT_HERE')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'YOUR_SPECIFIC_PROMPT_HERE'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Kintone REST Integration

- Supports both Kintone REST MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Kintone REST data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Kintone REST access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Kintone REST
- Scoped, least privilege access to Kintone REST resources
- Full audit trail of agent actions to support review and compliance

## Use Kintone REST with any AI Agent Framework

Choose a framework you want to connect Kintone REST with:

- [ChatGPT](https://composio.dev/toolkits/kintone_rest/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/kintone_rest/framework/claude-cowork)
- [Hermes](https://composio.dev/toolkits/kintone_rest/framework/hermes-agent)
- [Atomic Agent](https://composio.dev/toolkits/kintone_rest/framework/atomic-agent)

## Related Toolkits

- [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.
- [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.
- [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.
- [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals.
- [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem.
- [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity.
- [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently.
- [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place.
- [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place.
- [AirOps MCP](https://composio.dev/toolkits/airops_mcp) - AirOps MCP is AirOps' managed content platform exposing brand context, knowledge bases, and workflows. Use it to give agents brand-aware content, automate content workflows, and track Brand Kit edits.
- [Amazing Marvin](https://composio.dev/toolkits/amazing_marvin) - Amazing Marvin is a personal productivity app for tasks, projects, habits, planning, time tracking, and rewards. It helps you build a flexible workflow that matches how you actually work.
- [AnyDB](https://composio.dev/toolkits/any_db) - AnyDB is a flexible collaborative database platform for organizing records, files, and automated workflows. It helps teams centralize data, collaborate on records, and automate routine tasks.
- [ApptiveGrid](https://composio.dev/toolkits/apptivegrid) - ApptiveGrid is a collaborative no-code database and app platform for spaces, grids, forms, and structured records. It helps teams organize operational data, collect inputs, and build lightweight business apps without custom backend work.
- [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place.
- [Atlassian MCP](https://composio.dev/toolkits/atlassian_mcp) - Atlassian Rovo MCP connects agents to Jira, Jira Service Management, Confluence, Bitbucket, Compass, and Teamwork Graph workflows. It lets teams surface and act on Atlassian data while respecting existing user permissions.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives.
- [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions.

## Frequently Asked Questions

### Do I need my own developer credentials to use Kintone REST with Composio?

Yes, Kintone REST requires you to configure your own OAuth credentials. Once set up, Composio handles token storage, refresh, and lifecycle management for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)