Kintone REST for AI agents
Agents read Kintone REST at once. Changes and sends are held for a person's approval by default.
About Kintone REST
Manage Kintone records and app settings with delegated OAuth access through the Kintone REST API.
What an agent can do in Kintone REST
Every Kintone REST action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Kintone REST without asking first. 22 actions.
- Download FileDownload an attachment up to 100 MB using the file key returned by a record read. Files larger than 100 MB are rejected.
- Get Action SettingsReturn deployed or unpublished record-copy action settings of an app, including destinations, mappings, availability, order, and revision.
- Get AppGets 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 App Deploy StatusGet the deployment status of settings for up to 300 Kintone apps.
- Get App PermissionsReturn deployed or unpublished app-level permissions and settings revision in priority order.
- Get App SettingsReturn an app's deployed or unpublished name, description, title-field configuration, feature flags, theme, icon, and revision.
- Get CustomizationReturn deployed or unpublished desktop and mobile JavaScript and CSS customization files, scope, and revision for an app.
- Get Field PermissionsReturn deployed or unpublished field permissions, including prioritized subjects and each field's access level.
- Get FormRead 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, b
- Get Form FieldsReturn deployed or unpublished field codes, types, labels, and settings so an agent can construct valid record values and queries.
- Get Form LayoutReturn deployed or unpublished field layout information for an app form, including rows, groups, tables, fields, and sizes.
- Get General Notification SettingsGet an app's deployed or unpublished general-notification recipients, event conditions, commenter option, and revision.
Show all 22
- Get Graph SettingsReturn deployed or unpublished graph definitions with their chart, aggregation, grouping, sorting, periodic-report settings, and revision.
- Get Per Record Notification SettingsGet an app's deployed or unpublished conditional per-record notifications, recipients, subjects, and revision.
- Get Process Management SettingsReturn deployed or unpublished process-management enablement, statuses, assignee rules, transitions, branch conditions, and revision.
- Get RecordRetrieve one record from a Kintone app by its record ID.
- Get Record PermissionsReturn deployed or unpublished record permission rules, preserving each query filter and prioritized subject list.
- Get Reminder Notification SettingsGet an app's deployed or unpublished reminder timing, filters, recipients, timezone, and revision.
- Get ViewsReturn deployed or unpublished list, calendar, custom, and built-in view settings, including filters, sorting, displayed fields, and revision.
- List AppsFind apps visible to the connected Kintone user by name, ID, code, or space and return one offset-controlled page of app metadata.
- List CommentsRetrieve one offset-controlled page of up to 10 comments from a Kintone record. The app's commenting feature must be enabled.
- Search RecordsSearch an app's records with a Kintone query and return one offset-controlled page. OAuth searches cannot continue beyond offset 10,000.
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 31 actions.
- Add CommentAdd one comment to a Kintone record, optionally mentioning up to 10 users, groups, or organizations. The app's commenting feature must be enabled.
- Add Form FieldsAdd 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.
- Add Preview AppCreate 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. De
- Create RecordCreate one record in a Kintone app from field-code values and return its record ID and revision.
- Create RecordsCreate one to 100 records atomically in one Kintone app and return their record IDs and revisions in input order.
- Delete CommentPermanently delete one comment from a Kintone record. With OAuth user authentication, only a comment created by that user can be deleted.
- Delete Form FieldsDelete 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 revi
- Delete RecordsPermanently 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.
- Deploy App SettingsAtomically 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.
- Discard App Settings ChangesPermanently 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 r
- Update Action SettingsReplace 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
- Update App PermissionsReplace 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
Show all 31
- Update AssigneesReplace 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 CustomizationUpdate unpublished desktop and mobile JavaScript and CSS customization. Deploy app settings separately to make changes live.
- Update Field PermissionsReplace 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
- Update Form FieldsUpdate 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.
- Update Form LayoutReplace 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.
- Update General SettingsUpdate unpublished general app settings such as name, description, icon, theme, feature flags, title field, and number precision. Deploy separately.
- Update Graph SettingsReplace 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 separa
- Update Per Record Notification SettingsReplace an app's undeployed per-record notification rules; deploy the app settings afterward to make them live.
- Update Preview App PermissionsReplace 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 pre
- Update Preview Field PermissionsReplace 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 fir
- Update Preview Record PermissionsReplace 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 recor
- Update Process Management SettingsUpdate 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
- Update RecordUpdate selected fields of one Kintone record by record ID, optionally requiring an expected revision.
- Update Record PermissionsReplace 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 affecte
- Update RecordsUpdate 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.
- Update StatusRun one Process Management action to update a Kintone record's workflow status, optionally selecting the next assignee and checking the current revision.
- Update StatusesRun Process Management actions for one to 100 Kintone records in the same app, optionally selecting assignees and checking revisions.
- Update ViewsReplace 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 se
- Upload FileUpload one managed file to Kintone and return the temporary file key used to attach it to a record within three days.
Changes wait in Needs you
Changes and sends in Kintone REST are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Kintone REST questions
Can an agent change data in Kintone REST on its own?
Not by default. Changes and sends in Kintone REST are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Kintone REST?
This connector lists 22 read actions. Reads run at once, without waiting for approval.
How does Kintone REST connect?
It connects with OAuth 2.0. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.