Kintone REST

Deploy app settings

Atomically apply the complete pre-live settings of up to 300 Kintone apps to their live apps.

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.

Download file

Download an attachment up to 100 MB using the file key returned by a record read.

Get action settings

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

Get app

Gets general information of an App, including the name, description, related Space, creator and updater information.

Get app deploy status

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

Get app permissions

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

Get app settings

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

Get customization

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

Get field permissions

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

Get form

Read a deployed or unpublished app form in Kintone's legacy property-array format.

Get form fields

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

Get form layout

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

Get general notification settings

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

Get graph settings

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

Get per record notification settings

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

Get process management settings

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

Get record

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

Get record permissions

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

Get reminder notification settings

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

Get views

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

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.

List comments

Retrieve one offset-controlled page of up to 10 comments from a Kintone record.

Search records

Search an app's records with a Kintone query and return one offset-controlled page.

Update action settings

Replace the complete unpublished record-copy action map.

Update app permissions

Replace app-level permissions in priority order and deploy all pending app settings, not only permissions.

Update assignees

Replace the assignees of one Kintone record whose app uses Process Management.

Update customization

Update unpublished desktop and mobile JavaScript and CSS customization.

Update field permissions

Replace field permissions and deploy all pending app settings, not only permissions.

Update form fields

Update typed field settings in an app's pre-live form.

Update form layout

Replace an app's complete pre-live form layout.

Update general notification settings

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

Update general settings

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

Update graph settings

Replace the complete unpublished graph map.

Update per record notification settings

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

Update preview app permissions

Replace the complete unpublished app-level permission list in priority order without deploying it.

Update preview field permissions

Replace the complete unpublished field permission list without deploying it.

Update preview record permissions

Replace the complete unpublished record permission rule list without deploying it.

Update process management settings

Update unpublished process-management settings.

Update record

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

Update record permissions

Replace record permission rules and deploy all pending app settings, not only permissions.

Update records

Update selected fields of one to 100 Kintone records atomically by record ID, optionally checking each revision.

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.

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.

Update statuses

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

Update views

Replace the complete unpublished list, calendar, and custom view map.

Upload file

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