---
canonical_url: "https://docs.composio.dev/toolkits/kintone_rest"
markdown_url: "https://docs.composio.dev/toolkits/kintone_rest.md"
product: "platform"
version: null
last_updated: null
---

# Kintone REST

Manage Kintone records and app settings with delegated OAuth access through the Kintone REST API.

- **Category:** app builder
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 55
- **Triggers:** 0
- **Slug:** `KINTONE_REST`
- **Version:** 00000000_00

## Tools

### Add Comment

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Comment text, from 1 to 65,535 characters. |
| `app_id` | integer | Yes | App ID containing the record. |
| `mentions` | array | No | Users, groups, or organizations to mention, up to 10. |
| `record_id` | integer | Yes | Record ID to comment on. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Form Fields

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app` | integer | Yes | App ID whose pre-live form should receive the fields. |
| `revision` | integer | No | Expected settings revision. Omit or use -1 to skip the revision check. |
| `properties` | object | Yes | Fields keyed by field code. Each value is selected by its type, including nested table fields. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Preview App

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the preview app, up to 64 characters. |
| `space` | integer | No | Space ID in which to create the app. |
| `thread` | integer | No | Thread ID in the space. Omit to use the default thread, as Kintone recommends. |
| `guest_space_id` | integer | No | Guest Space ID for the guest-space route; omit for the regular route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Record

**Slug:** `KINTONE_REST_CREATE_RECORD`

Create one record in a Kintone app from field-code values and return its record ID and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID in which to create the record. |
| `record` | object | No | Record fields keyed by app field code. Each field must use Kintone's {value: ...} write format. Omit to create the record with Kintone field defaults; an empty object explicitly supplies no field values. Use Get App Form Fields first when needed. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Records

**Slug:** `KINTONE_REST_CREATE_RECORDS`

Create one to 100 records atomically in one Kintone app and return their record IDs and revisions in input order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID in which to create all records. |
| `records` | array | Yes | One to 100 records to create in order. Each object is keyed by app field code, and each field uses Kintone's {value: ...} write format. The entire batch is canceled if any record fails. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Comment

**Slug:** `KINTONE_REST_DELETE_COMMENT`

Permanently delete one comment from a Kintone record. With OAuth user authentication, only a comment created by that user can be deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the record. |
| `record_id` | integer | Yes | Record ID containing the comment. |
| `comment_id` | integer | Yes | Comment ID to permanently delete. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Form Fields

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the fields. |
| `fields` | array | Yes | Field codes to delete, from 1 to 100 codes. Deleting a group or table also deletes its contained fields. |
| `revision` | integer | No | Expected settings revision. Omit or use -1 to skip the revision check. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Records

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the records. |
| `revisions` | array | No | Expected revisions paired positionally with record_ids. Omit to skip checks; use -1 to skip one check. |
| `record_ids` | array | Yes | One to 100 record IDs to permanently delete. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deploy App Settings

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apps` | array | Yes | Apps to deploy atomically, from 1 to 300 entries. |
| `guest_space_id` | integer | No | Guest Space ID when every app belongs to that guest space; omit for regular apps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Discard App Settings Changes

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apps` | array | Yes | Apps whose entire pre-live settings changes should be discarded, from 1 to 300 entries. |
| `guest_space_id` | integer | No | Guest Space ID when every app belongs to that guest space; omit for regular apps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_key` | string | Yes | Attachment file key returned by Get Record or Search Records. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Action Settings

**Slug:** `KINTONE_REST_GET_ACTION_SETTINGS`

Return deployed or unpublished record-copy action settings of an app, including destinations, mappings, availability, order, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose settings should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized names. Use user for the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose general information should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Deploy Status

**Slug:** `KINTONE_REST_GET_APP_DEPLOY_STATUS`

Get the deployment status of settings for up to 300 Kintone apps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apps` | array | Yes | App IDs whose deployment status should be checked, from 1 to 300 IDs. |
| `guest_space_id` | integer | No | Guest Space ID when every requested app belongs to that guest space; omit for regular apps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Permissions

**Slug:** `KINTONE_REST_GET_APP_PERMISSIONS`

Return deployed or unpublished app-level permissions and settings revision in priority order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose app permissions should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Permissions state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Settings

**Slug:** `KINTONE_REST_GET_APP_SETTINGS`

Return an app's deployed or unpublished name, description, title-field configuration, feature flags, theme, icon, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose deployed settings should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized app settings; user uses the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customization

**Slug:** `KINTONE_REST_GET_CUSTOMIZATION`

Return deployed or unpublished desktop and mobile JavaScript and CSS customization files, scope, and revision for an app.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose settings should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Field Permissions

**Slug:** `KINTONE_REST_GET_FIELD_PERMISSIONS`

Return deployed or unpublished field permissions, including prioritized subjects and each field's access level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose field permissions should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Permissions state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose form details should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Form state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form Fields

**Slug:** `KINTONE_REST_GET_FORM_FIELDS`

Return deployed or unpublished field codes, types, labels, and settings so an agent can construct valid record values and queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose form fields should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized field and option names. Use user for the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Form state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form Layout

**Slug:** `KINTONE_REST_GET_FORM_LAYOUT`

Return deployed or unpublished field layout information for an app form, including rows, groups, tables, fields, and sizes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose form layout should be returned. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Form state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get General Notification Settings

**Slug:** `KINTONE_REST_GET_GENERAL_NOTIFICATION_SETTINGS`

Get an app's deployed or unpublished general-notification recipients, event conditions, commenter option, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose notification settings to get. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Graph Settings

**Slug:** `KINTONE_REST_GET_GRAPH_SETTINGS`

Return deployed or unpublished graph definitions with their chart, aggregation, grouping, sorting, periodic-report settings, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose settings should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized names. Use user for the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Per Record Notification Settings

**Slug:** `KINTONE_REST_GET_PER_RECORD_NOTIFICATION_SETTINGS`

Get an app's deployed or unpublished conditional per-record notifications, recipients, subjects, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose notification settings to get. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language used for localized option names in filter conditions. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Process Management Settings

**Slug:** `KINTONE_REST_GET_PROCESS_MANAGEMENT_SETTINGS`

Return deployed or unpublished process-management enablement, statuses, assignee rules, transitions, branch conditions, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose settings should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized names. Use user for the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record

**Slug:** `KINTONE_REST_GET_RECORD`

Retrieve one record from a Kintone app by its record ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the record. |
| `record_id` | integer | Yes | Kintone record ID to retrieve. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record Permissions

**Slug:** `KINTONE_REST_GET_RECORD_PERMISSIONS`

Return deployed or unpublished record permission rules, preserving each query filter and prioritized subject list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose record permissions should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language used for localized option names in permission filter conditions. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Permissions state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reminder Notification Settings

**Slug:** `KINTONE_REST_GET_REMINDER_NOTIFICATION_SETTINGS`

Get an app's deployed or unpublished reminder timing, filters, recipients, timezone, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose notification settings to get. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language used for localized option names in filter conditions. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed or preview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Views

**Slug:** `KINTONE_REST_GET_VIEWS`

Return deployed or unpublished list, calendar, custom, and built-in view settings, including filters, sorting, displayed fields, and revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose settings should be returned. |
| `language` | string ("default" | "en" | "zh" | "ja" | "user") | No | Language for localized names. Use user for the connected user's language. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |
| `deployment_state` | string ("deployed" | "preview") | Yes | Settings state to read: deployed for live settings or preview for unpublished changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Apps

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Partial app-name search; matching is case-insensitive and includes the connected user's localized app name. |
| `limit` | integer | No | Maximum apps to return in this page, from 1 to 100. |
| `offset` | integer | No | Number of matching apps to skip; pass the prior next_offset to continue. |
| `app_ids` | array | No | Exact app IDs to return, up to 100. |
| `app_codes` | array | No | Exact case-sensitive app codes to return, up to 100; each code must be 1-64 characters. |
| `space_ids` | array | No | Return apps belonging to any of these space IDs, up to 100 IDs. |
| `guest_space_id` | integer | No | Guest Space ID when listing apps through the guest-space API route; omit for regular apps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Comments

**Slug:** `KINTONE_REST_LIST_COMMENTS`

Retrieve one offset-controlled page of up to 10 comments from a Kintone record. The app's commenting feature must be enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum comments to return in this page, from 1 to 10. |
| `order` | string ("ASC" | "DESC") | No | Comment ID sort order. |
| `app_id` | integer | Yes | App ID containing the record. |
| `offset` | integer | No | Number of comments to skip; pass the prior next_offset to continue. |
| `record_id` | integer | Yes | Record ID whose comments to retrieve. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Records

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records in this page, from 1 to 500. |
| `query` | string | No | Kintone filter and order expression. Do not include limit or offset clauses; this tool appends them. |
| `app_id` | integer | Yes | App ID whose records should be searched. |
| `fields` | array | No | Field codes to include; omit to return all accessible app fields. |
| `offset` | integer | No | Records to skip, from 0 to 10,000; pass prior next_offset to continue. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |
| `include_total_count` | boolean | No | Whether to ask Kintone for the total matching record count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Action Settings

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview action settings should be updated. |
| `actions` | object | Yes | Complete desired preview action map keyed by default-language name. Existing actions omitted from this map are deleted. Read preview action settings first and include every action that must be retained. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update App Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose deployed app permissions should be replaced. |
| `rights` | array | Yes | Complete app permission list in priority order. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Assignees

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the record. |
| `revision` | integer | No | Expected current record revision. Omit or use -1 to skip the revision check. |
| `assignees` | array | Yes | User codes to assign, up to 100. Pass an empty list to remove all assignees. |
| `record_id` | integer | Yes | Record ID whose assignees to replace. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customization

**Slug:** `KINTONE_REST_UPDATE_CUSTOMIZATION`

Update unpublished desktop and mobile JavaScript and CSS customization. Deploy app settings separately to make changes live.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("ALL" | "ADMIN" | "NONE") | No | Users affected by the customization. |
| `app_id` | integer | Yes | App ID whose preview customization should be updated. |
| `mobile` | object | No | Mobile JavaScript and CSS settings. |
| `desktop` | object | No | Desktop JavaScript and CSS settings. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Field Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose deployed field permissions should be replaced. |
| `rights` | array | Yes | Complete field permission list in priority order. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Form Fields

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app` | integer | Yes | App ID whose pre-live field settings should change. |
| `revision` | integer | No | Expected settings revision. Omit or use -1 to skip the revision check. |
| `properties` | object | Yes | Partial field updates keyed by current field code. Select each value by type; use code inside a value to rename that field. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Form Layout

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app` | integer | Yes | App ID whose pre-live form layout should change. |
| `layout` | array | Yes | Complete form layout. Include every field in typed ROW, SUBTABLE, or recursive GROUP entries; omitted fields are removed from the layout. |
| `revision` | integer | No | Expected settings revision. Omit or use -1 to skip the revision check. |
| `guest_space_id` | integer | No | Guest Space ID when the app belongs to a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update General Notification Settings

**Slug:** `KINTONE_REST_UPDATE_GENERAL_NOTIFICATION_SETTINGS`

Replace or selectively update an app's undeployed general-notification settings; deploy the app settings afterward to make them live.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview settings to update. |
| `revision` | integer | No | Latest settings revision for optimistic concurrency; omit or use -1 to skip the check. |
| `notifications` | array | No | Complete replacement recipients and event conditions; an empty list removes all recipients. Set this or notify_to_commenter. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |
| `notify_to_commenter` | boolean | No | Whether all commenters are notified. Set this or notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update General Settings

**Slug:** `KINTONE_REST_UPDATE_GENERAL_SETTINGS`

Update unpublished general app settings such as name, description, icon, theme, feature flags, title field, and number precision. Deploy separately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | object | No | Preset or uploaded app icon. |
| `name` | string | No | New app name. |
| `theme` | string ("WHITE" | "RED" | "BLUE" | "GREEN" | "YELLOW" | "BLACK") | No | App color theme. |
| `app_id` | integer | Yes | App ID whose preview general settings should be updated. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `description` | string | No | New HTML app description. |
| `title_field` | object | No | Record title-field settings. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |
| `enable_comments` | boolean | No | Whether record comments are enabled. |
| `number_precision` | object | No | Number precision settings. |
| `enable_thumbnails` | boolean | No | Whether thumbnails are shown. |
| `enable_bulk_deletion` | boolean | No | Whether users can bulk-delete records. |
| `enable_duplicate_record` | boolean | No | Whether users can duplicate records. |
| `first_month_of_fiscal_year` | integer | No | First fiscal-year month, from 1 to 12. |
| `enable_inline_record_editing` | boolean | No | Whether inline record editing is enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Graph Settings

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview graph settings should be updated. |
| `reports` | object | Yes | Complete desired preview graph map keyed by default-language name. Existing graphs omitted from this map are deleted. Read preview graph settings first and include every graph that must be retained. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Per Record Notification Settings

**Slug:** `KINTONE_REST_UPDATE_PER_RECORD_NOTIFICATION_SETTINGS`

Replace an app's undeployed per-record notification rules; deploy the app settings afterward to make them live.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview settings to update. |
| `revision` | integer | No | Latest settings revision for optimistic concurrency; omit or use -1 to skip the check. |
| `notifications` | array | Yes | Complete per-record notification settings; an empty list deletes all settings. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Preview App Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview app permissions should be replaced. |
| `rights` | array | Yes | Complete app permission list in priority order. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Preview Field Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview field permissions should be replaced. |
| `rights` | array | Yes | Complete field permission list in priority order. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Preview Record Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview record permissions should be replaced. |
| `rights` | array | Yes | Complete record permission list in priority order, including each filter condition. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Process Management Settings

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview process settings should be updated. |
| `enable` | boolean | No | Whether process management should be enabled. |
| `states` | object | No | Complete desired preview status map keyed by status name. Existing statuses omitted from this map are deleted; the first status cannot be deleted. Read preview process settings first and include every status that must be retained. |
| `actions` | array | No | Complete process transition list in display order. Each transition requires name, from, and to; filterCond is optional. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Record

**Slug:** `KINTONE_REST_UPDATE_RECORD`

Update selected fields of one Kintone record by record ID, optionally requiring an expected revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing the record. |
| `record` | object | Yes | Fields to change, keyed by app field code, with each value in Kintone's {value: ...} write format. Omitted fields are unchanged. |
| `revision` | string | No | Expected current revision for optimistic concurrency. Omit or use -1 to skip the revision check. |
| `record_id` | integer | Yes | Kintone record ID to update. This tool does not update by unique key. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Record Permissions

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose deployed record permissions should be replaced. |
| `rights` | array | Yes | Complete record permission list in priority order, including each filter condition. |
| `revision` | integer | No | Expected latest settings revision; omit or use -1 to skip the check. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Records

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing all records to update. |
| `records` | array | Yes | One to 100 record updates applied atomically. Every update selects a record by ID; this tool never upserts. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Reminder Notification Settings

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID whose preview settings to update. |
| `revision` | integer | No | Latest settings revision for optimistic concurrency; omit or use -1 to skip the check. |
| `timezone` | string | No | IANA timezone used to calculate reminder times. Set this or notifications. |
| `notifications` | array | No | Complete reminder rules; an empty list removes all rules. Set this or timezone. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Status

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | Process Management action name in the authenticated user's language. |
| `app_id` | integer | Yes | App ID containing the record. |
| `assignee` | string | No | Next assignee's user code. Required by Kintone when the workflow action requires choosing an assignee. |
| `revision` | integer | No | Expected current record revision. Omit or use -1 to skip the revision check. |
| `record_id` | integer | Yes | Record ID whose workflow status to update. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Statuses

**Slug:** `KINTONE_REST_UPDATE_STATUSES`

Run Process Management actions for one to 100 Kintone records in the same app, optionally selecting assignees and checking revisions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | integer | Yes | App ID containing all records to update. |
| `records` | array | Yes | One to 100 workflow status updates, each selecting a record by ID. |
| `guest_space_id` | integer | No | Guest Space ID when the app is in a guest space; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Views

**Slug:** `KINTONE_REST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `views` | object | Yes | Complete desired preview view map keyed by default-language name. Existing views omitted from this map are deleted. Read preview views first and include every view that must be retained. |
| `app_id` | integer | Yes | App ID whose preview views should be updated. |
| `revision` | integer | No | Expected current settings revision. Omit or use -1 to skip revision checking. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `KINTONE_REST_UPLOAD_FILE`

Upload one managed file to Kintone and return the temporary file key used to attach it to a record within three days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Single managed file to upload to Kintone. |
| `guest_space_id` | integer | No | Guest Space ID; omit for a regular app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |