Kintone

Kintone REST API

Kintone REST API endpoints from Kintone

Productivity & workspace#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Kintone REST API endpoints from Kintone

Endpoints 204

APPS

  • GETgetAppForGuestSpace/k/guest/:guestSpaceId/v1/app.json?id=0Gets general information of an App, including the name, description, related Space, creator and updater information.
  • GETgetAppAclForGuestSpace/k/guest/:guestSpaceId/v1/app/acl.json?app=0Gets the App permissions of an App.
  • PUTputAppAclForGuestSpace/k/guest/:guestSpaceId/v1/app/acl.jsonUpdates the App permissions of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using this API.
  • GETgetAppActionsForGuestSpace/k/guest/:guestSpaceId/v1/app/actions.json?app=0Gets the Action Settings of the App.
  • GETgetAppAdminNotesForGuestSpace/k/guest/:guestSpaceId/v1/app/adminNotes.json?app=stringGets notes for app administrators and their settings.
  • GETgetAppCustomizeForGuestSpace/k/guest/:guestSpaceId/v1/app/customize.json?app=0Gets the JavaScript and CSS Customization settings of an App.
  • GETgetAppFormFieldsForGuestSpace/k/guest/:guestSpaceId/v1/app/form/fields.json?app=0Gets the list of fields and field settings of an App.
  • GETgetAppFormLayoutForGuestSpace/k/guest/:guestSpaceId/v1/app/form/layout.json?app=0Gets the field layout info of a form in an App.
  • POSTpostAppMoveForGuestSpace/k/guest/:guestSpaceId/v1/app/move.jsonChanges the Space to which an App belongs.
  • GETgetAppNotificationsGeneralForGuestSpace/k/guest/:guestSpaceId/v1/app/notifications/general.json?app=0Gets the General Notification settings of the App.
  • GETgetAppNotificationsPerRecordForGuestSpace/k/guest/:guestSpaceId/v1/app/notifications/perRecord.json?app=0Gets the Per Record Notification settings of the App.
  • GETgetAppNotificationsReminderForGuestSpace/k/guest/:guestSpaceId/v1/app/notifications/reminder.json?app=0Gets the Reminder Notification settings of the App.
  • GETgetAppPluginsForGuestSpace/k/guest/:guestSpaceId/v1/app/plugins.json?app=0Gets the list of Plug-ins added to an App.
  • GETgetAppReportsForGuestSpace/k/guest/:guestSpaceId/v1/app/reports.json?app=0Gets the Graph settings of the App.
  • GETgetAppSettingsForGuestSpace/k/guest/:guestSpaceId/v1/app/settings.json?app=0Gets the description, name, icon, revision and color theme of an App.
  • GETgetAppStatusForGuestSpace/k/guest/:guestSpaceId/v1/app/status.json?app=0Gets the process management settings of an App.
  • GETgetAppViewsForGuestSpace/k/guest/:guestSpaceId/v1/app/views.json?app=0Gets the View settings of an App.
  • GETgetAppsForGuestSpace/k/guest/:guestSpaceId/v1/apps.jsonGets general information of multiple Apps, including the name, description, related Space, creator and updater information.
  • GETgetAppsStatisticsForGuestSpace/k/guest/:guestSpaceId/v1/apps/statistics.jsonGets the list of the usage status of Apps.
  • POSTpostPreviewAppForGuestSpace/k/guest/:guestSpaceId/v1/preview/app.jsonCreates a preview App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to the live App.
  • GETgetPreviewAppAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/acl.json?app=0Gets the App permissions of an App.
  • PUTputPreviewAppAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/acl.jsonUpdates the App permissions of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using this API.
  • GETgetPreviewAppActionsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/actions.json?app=0Gets the Action Settings of the App.
  • PUTputPreviewAppActionsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/actions.jsonUpdates the Action settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings…
  • GETgetPreviewAppAdminNotesForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/adminNotes.json?app=stringGets notes for app administrators and their settings.
  • PUTputPreviewAppAdminNotesForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/adminNotes.jsonUpdates the notes for App administrators and their settings.
  • GETgetPreviewAppCustomizeForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/customize.json?app=0Gets the JavaScript and CSS Customization settings of an App.
  • PUTputPreviewAppCustomizeForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/customize.jsonUpdates the JavaScript and CSS Customization settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API…
  • GETgetPreviewAppDeployForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/deploy.json?apps=0Gets the deployment status of the App settings for multiple Apps.
  • POSTdeployAppForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/deploy.jsonUpdates the settings of a pre-live App to the live App. Using this API gives the same results as when users click on "Update App" or "Discard Changes" on the…
  • GETgetPreviewAppFormFieldsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/fields.json?app=0Gets the list of fields and field settings of an App.
  • PUTputPreviewAppFormFieldsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/fields.jsonUpdates the field settings of fields in a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to…
  • POSTpostPreviewAppFormFieldsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/fields.jsonAdds fields to a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to the…
  • DELETEdeletePreviewAppFormFieldsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/fields.json?app=0&fields=stringDeletes fields from a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…
  • GETgetPreviewAppFormLayoutForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/layout.json?app=0Gets the field layout info of a form in an App.
  • PUTputPreviewAppFormLayoutForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/form/layout.jsonUpdates the field layout info of a form in an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the…
  • GETgetPreviewAppNotificationsGeneralForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/general.json?app=0Gets the General Notification settings of the App.
  • PUTputPreviewAppNotificationsGeneralForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/general.jsonUpdates the General Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy…
  • GETgetPreviewAppNotificationsPerRecordForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/perRecord.json?app=0Gets the Per Record Notification settings of the App.
  • PUTputPreviewAppNotificationsPerRecordForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/perRecord.jsonUpdates the Per Record Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to…
  • GETgetPreviewAppNotificationsReminderForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/reminder.json?app=0Gets the Reminder Notification settings of the App.
  • PUTputPreviewAppNotificationsReminderForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/notifications/reminder.jsonUpdates the Reminder Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy…
  • GETgetPreviewAppPluginsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/plugins.json?app=0Gets the list of Plug-ins added to an App.
  • POSTpostPreviewAppPluginsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/plugins.jsonAdds Plug-ins to an App.
  • GETgetPreviewAppReportsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/reports.json?app=0Gets the Graph settings of the App.
  • PUTputPreviewAppReportsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/reports.jsonUpdates the Graph settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…
  • GETgetPreviewAppSettingsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/settings.json?app=0Gets the description, name, icon, revision and color theme of an App.
  • PUTputPreviewAppSettingsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/settings.jsonUpdates the description, name, icon, revision and color theme of an App. This API updates the pre-live settings. After using this API, use the Deploy App…
  • GETgetPreviewAppStatusForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/status.json?app=0Gets the process management settings of an App.
  • PUTputPreviewAppStatusForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/status.jsonUpdates the process management settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the…
  • GETgetPreviewAppViewsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/views.json?app=0Gets the View settings of an App.
  • PUTputPreviewAppViewsForGuestSpace/k/guest/:guestSpaceId/v1/preview/app/views.jsonUpdates the View settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…
  • GETgetApp/k/v1/app.json?id=0Gets general information of an App, including the name, description, related Space, creator and updater information.
  • GETgetAppAcl/k/v1/app/acl.json?app=0Gets the App permissions of an App.
  • PUTputAppAcl/k/v1/app/acl.jsonUpdates the App permissions of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using this API.
  • GETgetAppActions/k/v1/app/actions.json?app=0Gets the Action Settings of the App.
  • GETgetAppAdminNotes/k/v1/app/adminNotes.json?app=stringGets notes for app administrators and their settings.
  • GETgetAppCustomize/k/v1/app/customize.json?app=0Gets the JavaScript and CSS Customization settings of an App.
  • GETgetAppFormFields/k/v1/app/form/fields.json?app=0Gets the list of fields and field settings of an App.
  • GETgetAppFormLayout/k/v1/app/form/layout.json?app=0Gets the field layout info of a form in an App.
  • POSTpostAppMove/k/v1/app/move.jsonChanges the Space to which an App belongs.
  • GETgetAppNotificationsGeneral/k/v1/app/notifications/general.json?app=0Gets the General Notification settings of the App.
  • GETgetAppNotificationsPerRecord/k/v1/app/notifications/perRecord.json?app=0Gets the Per Record Notification settings of the App.
  • GETgetAppNotificationsReminder/k/v1/app/notifications/reminder.json?app=0Gets the Reminder Notification settings of the App.
  • GETgetAppPlugins/k/v1/app/plugins.json?app=0Gets the list of Plug-ins added to an App.
  • GETgetAppReports/k/v1/app/reports.json?app=0Gets the Graph settings of the App.
  • GETgetAppSettings/k/v1/app/settings.json?app=0Gets the description, name, icon, revision and color theme of an App.
  • GETgetAppStatus/k/v1/app/status.json?app=0Gets the process management settings of an App.
  • GETgetAppViews/k/v1/app/views.json?app=0Gets the View settings of an App.
  • GETgetApps/k/v1/apps.jsonGets general information of multiple Apps, including the name, description, related Space, creator and updater information.
  • GETgetAppsStatistics/k/v1/apps/statistics.jsonGets the list of the usage status of Apps.
  • POSTpostPreviewApp/k/v1/preview/app.jsonCreates a preview App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to the live App.
  • GETgetPreviewAppAcl/k/v1/preview/app/acl.json?app=0Gets the App permissions of an App.
  • PUTputPreviewAppAcl/k/v1/preview/app/acl.jsonUpdates the App permissions of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using this API.
  • GETgetPreviewAppActions/k/v1/preview/app/actions.json?app=0Gets the Action Settings of the App.
  • PUTputPreviewAppActions/k/v1/preview/app/actions.jsonUpdates the Action settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings…
  • GETgetPreviewAppAdminNotes/k/v1/preview/app/adminNotes.json?app=stringGets notes for app administrators and their settings.
  • PUTputPreviewAppAdminNotes/k/v1/preview/app/adminNotes.jsonUpdates the notes for App administrators and their settings.
  • GETgetPreviewAppCustomize/k/v1/preview/app/customize.json?app=0Gets the JavaScript and CSS Customization settings of an App.
  • PUTputPreviewAppCustomize/k/v1/preview/app/customize.jsonUpdates the JavaScript and CSS Customization settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API…
  • GETgetPreviewAppDeploy/k/v1/preview/app/deploy.json?apps=0Gets the deployment status of the App settings for multiple Apps.
  • POSTdeployApp/k/v1/preview/app/deploy.jsonUpdates the settings of a pre-live App to the live App. Using this API gives the same results as when users click on "Update App" or "Discard Changes" on the…
  • GETgetPreviewAppFormFields/k/v1/preview/app/form/fields.json?app=0Gets the list of fields and field settings of an App.
  • PUTputPreviewAppFormFields/k/v1/preview/app/form/fields.jsonUpdates the field settings of fields in a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to…
  • POSTpostPreviewAppFormFields/k/v1/preview/app/form/fields.jsonAdds fields to a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to the…
  • DELETEdeletePreviewAppFormFields/k/v1/preview/app/form/fields.json?app=0&fields=stringDeletes fields from a form of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…
  • GETgetPreviewAppFormLayout/k/v1/preview/app/form/layout.json?app=0Gets the field layout info of a form in an App.
  • PUTputPreviewAppFormLayout/k/v1/preview/app/form/layout.jsonUpdates the field layout info of a form in an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the…
  • GETgetPreviewAppNotificationsGeneral/k/v1/preview/app/notifications/general.json?app=0Gets the General Notification settings of the App.
  • PUTputPreviewAppNotificationsGeneral/k/v1/preview/app/notifications/general.jsonUpdates the General Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy…
  • GETgetPreviewAppNotificationsPerRecord/k/v1/preview/app/notifications/perRecord.json?app=0Gets the Per Record Notification settings of the App.
  • PUTputPreviewAppNotificationsPerRecord/k/v1/preview/app/notifications/perRecord.jsonUpdates the Per Record Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to…
  • GETgetPreviewAppNotificationsReminder/k/v1/preview/app/notifications/reminder.json?app=0Gets the Reminder Notification settings of the App.
  • PUTputPreviewAppNotificationsReminder/k/v1/preview/app/notifications/reminder.jsonUpdates the Reminder Notification settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy…
  • GETgetPreviewAppPlugins/k/v1/preview/app/plugins.json?app=0Gets the list of Plug-ins added to an App.
  • POSTpostPreviewAppPlugins/k/v1/preview/app/plugins.jsonAdds Plug-ins to an App.
  • GETgetPreviewAppReports/k/v1/preview/app/reports.json?app=0Gets the Graph settings of the App.
  • PUTputPreviewAppReports/k/v1/preview/app/reports.jsonUpdates the Graph settings of the App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…
  • GETgetPreviewAppSettings/k/v1/preview/app/settings.json?app=0Gets the description, name, icon, revision and color theme of an App.
  • PUTputPreviewAppSettings/k/v1/preview/app/settings.jsonUpdates the description, name, icon, revision and color theme of an App. This API updates the pre-live settings. After using this API, use the Deploy App…
  • GETgetPreviewAppStatus/k/v1/preview/app/status.json?app=0Gets the process management settings of an App.
  • PUTputPreviewAppStatus/k/v1/preview/app/status.jsonUpdates the process management settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the…
  • GETgetPreviewAppViews/k/v1/preview/app/views.json?app=0Gets the View settings of an App.
  • PUTputPreviewAppViews/k/v1/preview/app/views.jsonUpdates the View settings of an App. This API updates the pre-live settings. After using this API, use the Deploy App Settings API to deploy the settings to…

RECORDS

  • POSTpostBulkRequestForGuestSpace/k/guest/:guestSpaceId/v1/bulkRequest.jsonRuns multiple API requests sequentially to multiple Apps.
  • GETgetPreviewRecordAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/record/acl.json?app=0Gets the Record permission settings of an App.
  • PUTputPreviewRecordAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/record/acl.jsonUpdates the Record permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by…
  • GETgetRecordForGuestSpace/k/guest/:guestSpaceId/v1/record.json?app=0&id=0Retrieves details of 1 record from an App by specifying the App ID and Record ID.
  • PUTputRecordForGuestSpace/k/guest/:guestSpaceId/v1/record.jsonUpdates details of 1 record in an App by specifying its record number, or a different unique key.
  • POSTpostRecordForGuestSpace/k/guest/:guestSpaceId/v1/record.jsonAdds 1 record to an App.
  • GETgetRecordAclForGuestSpace/k/guest/:guestSpaceId/v1/record/acl.json?app=0Gets the Record permission settings of an App.
  • PUTputRecordAclForGuestSpace/k/guest/:guestSpaceId/v1/record/acl.jsonUpdates the Record permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by…
  • PUTputRecordAssigneesForGuestSpace/k/guest/:guestSpaceId/v1/record/assignees.jsonUpdates the Assignees of a Record status, that was set with Process Management.
  • POSTpostRecordCommentForGuestSpace/k/guest/:guestSpaceId/v1/record/comment.jsonAdd a comment to a record in an app.
  • DELETEdeleteRecordCommentForGuestSpace/k/guest/:guestSpaceId/v1/record/comment.json?app=0&record=0&comment=0Delete a comment in a record in an app.
  • GETgetRecordCommentsForGuestSpace/k/guest/:guestSpaceId/v1/record/comments.json?app=0&record=0Retrieves multiple comments from a record in an app.
  • PUTputRecordStatusForGuestSpace/k/guest/:guestSpaceId/v1/record/status.jsonUpdates the Status of a record of an App, that was set with Process Management.
  • GETgetRecordsForGuestSpace/k/guest/:guestSpaceId/v1/records.json?app=0Retrieves details of multiple records from an App by specifying the App ID and a query string.
  • GETgetRecordsAclEvaluateForGuestSpace/k/guest/:guestSpaceId/v1/records/acl/evaluate.json?app=0&ids=0Evaluates the API user's permissions for records and fields within an App.
  • GETgetRecordsCursorForGuestSpace/k/guest/:guestSpaceId/v1/records/cursor.json?id=stringRetrieves multiple records from an App by specifying the cursor ID.
  • POSTpostRecordsCursorForGuestSpace/k/guest/:guestSpaceId/v1/records/cursor.jsonAdds a cursor so that large amount of records can be obtained from an App.
  • DELETEdeleteRecordsCursorForGuestSpace/k/guest/:guestSpaceId/v1/records/cursor.json?id=stringDeletes a cursor by specifying the cursor ID.
  • PUTputRecordsStatusForGuestSpace/k/guest/:guestSpaceId/v1/records/status.jsonUpdates the Statuses of Multiple records of an App, that was set with Process Management.
  • POSTpostBulkRequest/k/v1/bulkRequest.jsonRuns multiple API requests sequentially to multiple Apps.
  • GETgetPreviewRecordAcl/k/v1/preview/record/acl.json?app=0Gets the Record permission settings of an App.
  • PUTputPreviewRecordAcl/k/v1/preview/record/acl.jsonUpdates the Record permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by…
  • GETgetRecord/k/v1/record.json?app=0&id=0Retrieves details of 1 record from an App by specifying the App ID and Record ID.
  • PUTputRecord/k/v1/record.jsonUpdates details of 1 record in an App by specifying its record number, or a different unique key.
  • POSTpostRecord/k/v1/record.jsonAdds 1 record to an App.
  • GETgetRecordAcl/k/v1/record/acl.json?app=0Gets the Record permission settings of an App.
  • PUTputRecordAcl/k/v1/record/acl.jsonUpdates the Record permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by…
  • PUTputRecordAssignees/k/v1/record/assignees.jsonUpdates the Assignees of a Record status, that was set with Process Management.
  • POSTpostRecordComment/k/v1/record/comment.jsonAdd a comment to a record in an app.
  • DELETEdeleteRecordComment/k/v1/record/comment.json?app=0&record=0&comment=0Delete a comment in a record in an app.
  • GETgetRecordComments/k/v1/record/comments.json?app=0&record=0Retrieves multiple comments from a record in an app.
  • PUTputRecordStatus/k/v1/record/status.jsonUpdates the Status of a record of an App, that was set with Process Management.
  • GETgetRecords/k/v1/records.json?app=0Retrieves details of multiple records from an App by specifying the App ID and a query string.
  • GETgetRecordsAclEvaluate/k/v1/records/acl/evaluate.json?app=0&ids=0Evaluates the API user's permissions for records and fields within an App.
  • GETgetRecordsCursor/k/v1/records/cursor.json?id=stringRetrieves multiple records from an App by specifying the cursor ID.
  • POSTpostRecordsCursor/k/v1/records/cursor.jsonAdds a cursor so that large amount of records can be obtained from an App.
  • DELETEdeleteRecordsCursor/k/v1/records/cursor.json?id=stringDeletes a cursor by specifying the cursor ID.
  • PUTputRecordsStatus/k/v1/records/status.jsonUpdates the Statuses of Multiple records of an App, that was set with Process Management.

FIELDS

  • GETgetFieldAclForGuestSpace/k/guest/:guestSpaceId/v1/field/acl.json?app=0Gets the Field permission settings of an App.
  • PUTputFieldAclForGuestSpace/k/guest/:guestSpaceId/v1/field/acl.jsonUpdates the Field permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using…
  • GETgetPreviewFieldAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/field/acl.json?app=0Gets the Field permission settings of an App.
  • PUTputPreviewFieldAclForGuestSpace/k/guest/:guestSpaceId/v1/preview/field/acl.jsonUpdates the Field permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using…
  • GETgetFieldAcl/k/v1/field/acl.json?app=0Gets the Field permission settings of an App.
  • PUTputFieldAcl/k/v1/field/acl.jsonUpdates the Field permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using…
  • GETgetPreviewFieldAcl/k/v1/preview/field/acl.json?app=0Gets the Field permission settings of an App.
  • PUTputPreviewFieldAcl/k/v1/preview/field/acl.jsonUpdates the Field permission settings of an App. All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using…

FILES

  • GETdownloadFileForGuestSpace/k/guest/:guestSpaceId/v1/file.json?fileKey=stringDownloads files from an attachment field in an App.
  • POSTuploadFileForGuestSpace/k/guest/:guestSpaceId/v1/file.jsonUploads a file to Kintone.
  • GETdownloadFile/k/v1/file.json?fileKey=stringDownloads files from an attachment field in an App.
  • POSTuploadFile/k/v1/file.jsonUploads a file to Kintone.

FORMS

  • GETgetFormForGuestSpace/k/guest/:guestSpaceId/v1/form.json?app=0Retrieves the form details of an App.
  • GETgetPreviewFormForGuestSpace/k/guest/:guestSpaceId/v1/preview/form.json?app=0Retrieves the form details of an App.
  • GETgetForm/k/v1/form.json?app=0Retrieves the form details of an App.
  • GETgetPreviewForm/k/v1/preview/form.json?app=0Retrieves the form details of an App.

SPACES

  • POSTpostGuestsForGuestSpace/k/guest/:guestSpaceId/v1/guests.jsonAdds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user…
  • DELETEdeleteGuestsForGuestSpace/k/guest/:guestSpaceId/v1/guests.json?guests=user@example.comDeletes a Guest user from Kintone. To remove a user from a Guest Space without deleting their account, use the Update Guest Members API.
  • GETgetSpaceForGuestSpace/k/guest/:guestSpaceId/v1/space.json?id=0Gets information of a Space.
  • PUTputSpaceForGuestSpace/k/guest/:guestSpaceId/v1/space.jsonUpdates the settings of a Space.
  • DELETEdeleteSpaceForGuestSpace/k/guest/:guestSpaceId/v1/space.json?id=0Deletes a Space.
  • PUTputSpaceBodyForGuestSpace/k/guest/:guestSpaceId/v1/space/body.jsonUpdates the body of a Space.
  • PUTputSpaceGuestsForGuestSpace/k/guest/:guestSpaceId/v1/space/guests.jsonUpdates the Guest Members of a Space.
  • GETgetSpaceMembersForGuestSpace/k/guest/:guestSpaceId/v1/space/members.json?id=0Gets the list of Space Members of a Space.
  • PUTputSpaceMembersForGuestSpace/k/guest/:guestSpaceId/v1/space/members.jsonUpdates the Members of a Space.
  • PUTputSpaceThreadForGuestSpace/k/guest/:guestSpaceId/v1/space/thread.jsonUpdates a Thread of a Space.
  • POSTpostSpaceThreadForGuestSpace/k/guest/:guestSpaceId/v1/space/thread.jsonAdds a Thread in a Space.
  • POSTpostSpaceThreadCommentForGuestSpace/k/guest/:guestSpaceId/v1/space/thread/comment.jsonAdds a comment to a Thread of a Space.
  • GETgetSpacesStatisticsForGuestSpace/k/guest/:guestSpaceId/v1/spaces/statistics.json
  • POSTpostTemplateSpaceForGuestSpace/k/guest/:guestSpaceId/v1/template/space.jsonCreates a Space from a Space template.
  • POSTpostGuests/k/v1/guests.jsonAdds Guest users to Kintone. This does not affiliate Guest users with any Guest Spaces, and does not send any invitation emails. To affiliate a Guest user…
  • DELETEdeleteGuests/k/v1/guests.json?guests=user@example.comDeletes a Guest user from Kintone. To remove a user from a Guest Space without deleting their account, use the Update Guest Members API.
  • GETgetSpace/k/v1/space.json?id=0Gets information of a Space.
  • PUTputSpace/k/v1/space.jsonUpdates the settings of a Space.
  • DELETEdeleteSpace/k/v1/space.json?id=0Deletes a Space.
  • PUTputSpaceBody/k/v1/space/body.jsonUpdates the body of a Space.
  • PUTputSpaceGuests/k/v1/space/guests.jsonUpdates the Guest Members of a Space.
  • GETgetSpaceMembers/k/v1/space/members.json?id=0Gets the list of Space Members of a Space.
  • PUTputSpaceMembers/k/v1/space/members.jsonUpdates the Members of a Space.
  • PUTputSpaceThread/k/v1/space/thread.jsonUpdates a Thread of a Space.
  • POSTpostSpaceThread/k/v1/space/thread.jsonAdds a Thread in a Space.
  • POSTpostSpaceThreadComment/k/v1/space/thread/comment.jsonAdds a comment to a Thread of a Space.
  • GETgetSpacesStatistics/k/v1/spaces/statistics.json
  • POSTpostTemplateSpace/k/v1/template/space.jsonCreates a Space from a Space template.

PLUGINS

  • PUTputPluginForGuestSpace/k/guest/:guestSpaceId/v1/plugin.jsonUpdates an imported plug-in in the Kintone environment.
  • POSTinstallPluginForGuestSpace/k/guest/:guestSpaceId/v1/plugin.jsonImports a plug-in into Kintone.
  • DELETEuninstallPluginForGuestSpace/k/guest/:guestSpaceId/v1/plugin.json?id=stringThe fileKey representing an uploaded file. Use the Upload File API to upload the file and retrieve the fileKey.
  • GETgetPluginAppsForGuestSpace/k/guest/:guestSpaceId/v1/plugin/apps.json?id=stringGets Apps that have the specified plug-in added.
  • GETgetPluginsForGuestSpace/k/guest/:guestSpaceId/v1/plugins.jsonGets the list of plug-ins imported into Kintone.
  • GETgetPluginsRequiredForGuestSpace/k/guest/:guestSpaceId/v1/plugins/required.jsonGets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps. This can occur when a plug-in is installed, added to an…
  • PUTputPlugin/k/v1/plugin.jsonUpdates an imported plug-in in the Kintone environment.
  • POSTinstallPlugin/k/v1/plugin.jsonImports a plug-in into Kintone.
  • DELETEuninstallPlugin/k/v1/plugin.json?id=stringThe fileKey representing an uploaded file. Use the Upload File API to upload the file and retrieve the fileKey.
  • GETgetPluginApps/k/v1/plugin/apps.json?id=stringGets Apps that have the specified plug-in added.
  • GETgetPlugins/k/v1/plugins.jsonGets the list of plug-ins imported into Kintone.
  • GETgetPluginsRequired/k/v1/plugins/required.jsonGets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps. This can occur when a plug-in is installed, added to an…

RECORD

  • PUTputRecordsForGuestSpace/k/guest/:guestSpaceId/v1/records.jsonUpdates details of multiple records in an App, by specifying their record numbers, or their unique keys. If the upsert parameter is set to true, it also adds…
  • POSTpostRecordsForGuestSpace/k/guest/:guestSpaceId/v1/records.jsonAdds multiple records to an App.
  • DELETEdeleteRecordsForGuestSpace/k/guest/:guestSpaceId/v1/records.json?app=0&ids=0Deletes multiple records in an app.
  • PUTputRecords/k/v1/records.jsonUpdates details of multiple records in an App, by specifying their record numbers, or their unique keys. If the upsert parameter is set to true, it also adds…
  • POSTpostRecords/k/v1/records.jsonAdds multiple records to an App.
  • DELETEdeleteRecords/k/v1/records.json?app=0&ids=0Deletes multiple records in an app.

API details

Base URL
https://{domainId}.cybozu.com
Authentication
None declared in the description
Operations
204 operations on 128 pathsGET 100PUT 58POST 32DELETE 14
Main resources
APPS 104RECORDS 38SPACES 28PLUGINS 12FIELDS 8RECORD 6FILES 4FORMS 4
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 20250423000000

How to test the Kintone REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Kintone REST API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “getAppForGuestSpace” (GET /k/guest/:guestSpaceId/v1/app.json?id=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Kintone REST API?

Kintone REST API endpoints from Kintone It is listed under Productivity & workspace and has 204 endpoints.

Who publishes the Kintone REST API?

It is listed from Kintone's public API description (an OpenAPI document), not published by Kintone on Swastik Codes. Anyone who controls kintone.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Kintone REST API?

Requests go to https://{domainId}.cybozu.com. Endpoint paths are added to this base URL.

How do I authenticate with the Kintone REST API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Kintone REST API have?

204 operations on 128 paths (100 GET, 58 PUT, 32 POST, 14 DELETE). The largest groups are APPS, RECORDS, SPACES, PLUGINS.

Is forking the Kintone REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.