Kintone REST API List

Apps

API Method URL
Apps Get App GET /k/v1/app.json
/k/v1/preview/app.json
Get Apps GET /k/v1/apps.json
Add Preview App POST /k/v1/preview/app.json
Deploy Deploy App Settings POST /k/v1/preview/app/deploy.json
Get App Deploy Status GET /k/v1/preview/app/deploy.json
Form Fields Get Form Fields GET /k/v1/app/form/fields.json
/k/v1/preview/app/form/fields.json
Add Form Fields POST /k/v1/preview/app/form/fields.json
Update Form Fields PUT /k/v1/preview/app/form/fields.json
Delete Form Fields DELETE /k/v1/preview/app/form/fields.json
Form Layout Get Form Layout GET /k/v1/app/form/layout.json
/k/v1/preview/app/form/layout.json
Update Form Layout PUT /k/v1/preview/app/form/layout.json
Views Get Views GET /k/v1/app/views.json
/k/v1/preview/app/views.json
Update Views PUT /k/v1/preview/app/views.json
General Settings Get General Settings GET /k/v1/app/settings.json
Update General Settings PUT /k/v1/preview/app/settings.json
Process Management Get Process Management Settings GET /k/v1/app/status.json
/k/v1/preview/app/status.json
Update Process Management Settings PUT /k/v1/preview/app/status.json
Customization Get Customization GET /k/v1/app/customize.json
/k/v1/preview/app/customize.json
Update Customization PUT /k/v1/preview/app/customize.json
App Permissions Get App Permissions GET /k/v1/app/acl.json
/k/v1/preview/app/acl.json
Update App Permissions PUT /k/v1/app/acl.json
/k/v1/preview/app/acl.json
Record Permissions Get Record Permissions GET /k/v1/record/acl.json
/k/v1/preview/record/acl.json
Update App Permissions PUT /k/v1/record/acl.json
/k/v1/preview/record/acl.json
Field Permissions Get Field Permissions GET /k/v1/field/acl.json
/k/v1/preview/field/acl.json
Update Record Permissions PUT /k/v1/field/acl.json
/k/v1/preview/field/acl.json
Record Permissions Evaluate Record Permissions GET /k/v1/records/acl/evaluate.json
Get Form Form GET /k/v1/form.json
/k/v1/preview/form.json

* Certain APIs concerning Apps can be executed only on form settings that have not been applied to the live App (ie. changes were made to the form settings but the App has not been updated), only on the live App, or either.

 

* The URL path in the case of settings that have not yet been updated to the live App is '/k/v1/preview/xxxx.json'. Refer to each individual document for details. 

 

Records

API Method URL
Record Get Record GET /k/v1/record.json
Get Records GET /k/v1/records.json
Add Record POST /k/v1/record.json
Add Records POST /k/v1/records.json
Update Record PUT /k/v1/record.json
Update Records PUT /k/v1/records.json
Delete Records DELETE /k/v1/records.json
Comments Get Comments GET /k/v1/record/comments.json
Add Comment POST /k/v1/record/comment.json
Delete Comment DELETE /k/v1/record/comment.json
File Download File GET /k/v1/file.json
Upload File POST /k/v1/file.json
Bulk Request Bulk Request POST /k/v1/bulkRequest.json
Process Management Update Status PUT /k/v1/record/status.json
Update Multiple Statuses PUT /k/v1/records/status.json
Update Assignees PUT /k/v1/record/assignees.json

 

Spaces

API Method URL
Space Get Space GET /k/v1/space.json
Add Space POST /k/v1/template/space.json
Update Space Body PUT /k/v1/space/body.json
Delete Space DELETE /k/v1/space.json
Space Members Get Space Members GET /k/v1/space/members.json
Update Space Members PUT /k/v1/space/members.json
Thread Add Thread Comment POST /k/v1/space/thread/comment.json
Update Thread PUT /k/v1/space/thread.json
Guests Add Guests POST /k/v1/guests.json
Update Guest Members PUT /k/guest/<SpaceID>/v1/space/guests.json
Delete Guests DELETE /k/v1/guests.json

 

API Info

API Method URL
Kintone REST API Get API List GET /k/v1/apis.json
Get API Schema GET /k/v1/apis/*.json
Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!