Kintone REST

Add one comment to a Kintone record, optionally mentioning up to 10 users, groups, or organizations. The app's commenting feature must be enabled.

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.

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.

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

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

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

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.

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.

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.

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.

Download an attachment up to 100 MB using the file key returned by a record read. Files larger than 100 MB are rejected.

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

Find apps visible to the connected Kintone user by name, ID, code, or space and return one offset-controlled page of app metadata.

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

Search an app's records with a Kintone query and return one offset-controlled page. OAuth searches cannot continue beyond offset 10,000.

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.

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.

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.

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

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.

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.

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.

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

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

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.

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

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.

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.

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.

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.

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

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.

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.

Replace or selectively update an app's undeployed reminder rules and timezone; deploy the app settings afterward to make them live.

Run one Process Management action to update a Kintone record's workflow status, optionally selecting the next assignee and checking the current revision.

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

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.

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