Kintone REST API Overview
The Kintone REST API
The Kintone REST API is capable of general create/retrieve/update/delete operations of App records, retrieving App descriptions, and manipulation of Spaces.
Refer to Authentication.
These request headers are used for the REST API. It is not necessary to specify request headers when using the Kintone REST API request API.
application/json or for multipart data:
Only required when sending a request body.
login_name:password encoded in base64. Only required when using
|The Kintone App's API Token. Only required when using API Token Authentication..
Basic followed by a Base64 encoded
login_name:password. Only required when using the deprecated
Basic Authentication, which is no longer available for kintone.com domains.
|The HTTP method. Specify one of the following:
By specifying an HTTP method on the X-HTTP-Method-Override and sending a
POST request, an API that corresponds to the specified HTTP method will run.
Request URI Too Large error that occurs when the request URI exceeds 8KB.
* This header method is available on all Kintone REST API routes, but behavior can not be guaranteed when using with external APIs.
* If a
GET request is sent using
kintone.api() and the length exceeds 4KB, the X-HTTP-Method-Override header will automatically be added and the request will be sent as a
The below request will run the Get Records API.
POST /k/v1/records.jsonRequest Body
|The Language Code, e.g.
Forces the data from a field to be returned in the specified language, if a localization has been set. This overrides the system locale language, and user locale language.
|This is the general request URI you should be using. If you are dealing with apps that are in guest spaces, use the below request URI.
|Apps in guest spaces
|If the app was made inside a guest space, this is the request URI you will need to use.
Note that guest users cannot initiate REST APIs.
The request body is formatted in JSON. Character encoding should be in UTF-8.
However when using the
File Upload API, the request body should be formatted as
\ can be used to escape characters within the JSON as necessary.
For API routes using the
GET method, request parameters can be passed via the URL as query parameters. For example, to specify an
App Id of 1, query parameters can be set like the following:
According to the URL Standard, keys and values of query parameters are encoded using URL Encoding. The example below shows a URL encoded string for "Updated_datetime > "2021-10-01T09:00:00+0900":
Decompose the array, and URL encode each element.
In the following example, the
Get Records API is used. The
fields parameter includes a
Record Id field and a
fields=[Record_Id,Dropdown]is decomposed into separate elements
- The keys and values of each parameter are URL encoded
HTTP Status Codes
HTTP status code 200 denotes that the request was successfully received.
Treat any other status code as errors. Errors will respond with JSON data including the following information.
|The error message. The language of the message will differ depending on the Kintone user's language settings.
|The ID of the error.
|The code of the error, to specify the type of error it is.
Sample Error Response
All Kintone REST APIs include the following details in the response header.
|The concurrent API Request Limit.
The default value is 100.
|The number of running concurrent API requests.
About the response of a request made with
kintone.api() to make requests for Kintone REST APIs, only the response body is passed to the callback function. To use other data that are not included in the response body, don't use
kintone.api() to make the requests, and use another method.
Date and time related fields follow the following formats.
|This is not converted to UTC.
The below date formats can be used:
|This is not converted to UTC.
|Date and time
- After Kintone updates, spec changes such as the addition of new fields and keys may be applied to the JSON formats of the request and response data.
- To view information of App, Record, Comment, and Space operations, view the audit logs. Refer to Monitoring Audit Logs from the Kintone Help Center for more details.
- The number of API requests available per day is 10,000 per App. For APIs that are not counted as part of the API call limits, see The number of API requests available per day .
- If a domain has IP address restriction, only API requests from an approved IP address will be successful.
- When operating on Lookup values with the Add Record(s) API and the Update Record(s) API, the Key Field of the Datasource App must be either a Record Number field or a field with the "Prohibit duplicate values" option turned on.
- If the Key Field of the Datasource App of a Lookup field is a Text field with the "Calculate automatically" option turned on, the Lookup field cannot be operated on with API.
For more information on limitations and usage of the Kintone REST API, please refer to the List of Limit Values REST API Section.