Skip to content
This repository was archived by the owner on Sep 24, 2026. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 16 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,26 @@
# kintone/rest-api-spec

[![CI](https://github.com/kintone/rest-api-spec/actions/workflows/ci.yaml/badge.svg)](https://github.com/kintone/rest-api-spec/actions/workflows/ci.yaml)
> [!IMPORTANT]
> This repository is no longer maintained and is being archived.
>
> The [OpenAPI](https://www.openapis.org/) Description for the kintone REST API now lives in
> **[kintone/openapi-spec](https://github.com/kintone/openapi-spec)**. The files kept here are frozen
> and no longer describe the current API.

[OpenAPI](https://www.openapis.org/) Description for the kintone REST API.
## Where to find the OpenAPI Description

> [!WARNING]
> Experimental: This repository is still under early development.
- Repository: [kintone/openapi-spec](https://github.com/kintone/openapi-spec)
- Bundled description, YAML: <https://raw.githubusercontent.com/kintone/openapi-spec/main/openapi.yaml>
- Bundled description, JSON: <https://raw.githubusercontent.com/kintone/openapi-spec/main/openapi.json>

- [Concept](#concept)
- [Usage](#usage)
- [OpenAPI Description (OAD)](#openapi-description-oad)
- [Website](#website)
- [Releases](#releases)
- [Limitations](#limitations)
- [License](#license)
The interactive website that this repository publishes is being taken down. To browse the API, read
the [kintone REST API reference](https://kintone.dev/en/docs/kintone/rest-api/).

## Concept
## Feedback

This repository provides the [OpenAPI](https://www.openapis.org/) Description (OAD) for the [kintone REST API](https://kintone.dev/en/docs/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.

## Usage

The specification for the kintone REST API is available in two formats: OAD files (for tools) and an interactive website (for humans).

### OpenAPI Description (OAD)

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. |

### Website

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.

## Releases

- The version for the following month will be released in the middle of each month.
- Outdated versions may be removed periodically.

## Limitations

- The API interface is based on the kintone REST API in the [Current Channel](https://jp.cybozu.help/k/en/admin/new_feature/new_feature_overview.html#new_feature_new_feature_overview_10), with all [Update Options](https://jp.cybozu.help/k/en/admin/new_feature/new_feature_overview.html) checkboxes left unchecked.
This repository no longer accepts issues or pull requests. For anything about the current
specification, follow the
[feedback guidance in kintone/openapi-spec](https://github.com/kintone/openapi-spec#feedback).

## License

Expand Down
Loading