OpenAPI Description for the kintone REST API.
Warning
Experimental: This repository is still under early development.
This repository provides the OpenAPI Description (OAD) for the kintone REST API.
OpenAPI is a specification for describing REST API interfaces. It is both human- and machine-readable.
It is widely supported by API-related tools and services, enabling tasks such as inspecting REST API responses using Postman or automatically generating REST API clients.
The specification for the kintone REST API is available in two formats: OAD files (for tools) and an interactive website (for humans).
OAD files are located in the kintone/${timestamp} directory, where ${timestamp} represents the publication date and time.
| File | Description |
|---|---|
kintone/${timestamp}/openapi.yaml |
A multi-file version of the API description using the $ref keyword. |
kintone/${timestamp}/bundled/openapi.yaml |
A bundled, single-file version of the API description for tools that do not support the $ref keyword. |
We host an interactive website that provides the API specification at: https://kintone.github.io/rest-api-spec/
You can browse the list of kintone REST APIs, view their request and response formats, and try out API calls by setting an authorization header.
- The version for the following month will be released in the middle of each month.
- Outdated versions may be removed periodically.
- The API interface is based on the kintone REST API in the Current Channel, with all Update Options checkboxes left unchecked.