Get API Schema

Gets the API schema info of a kintone API.
Method GET
URL https://{subdomain}.kintone.com/k/v1/apis/*.json
Authentication None
Content-Type  

Permissions

None

Request Parameters

None, but replace the "*.json" in the request URL with the apis.{key}.link obtained with the Get API List API. The Get API List and Get Schema API cannot be used.

Sample Request

JavaScript (using kintone REST API Request)

XMLHttpRequest

Response Parameters

Parameter Type Description
id String The ID of the API.
This can be obtained from the apis.(key) responded from the Get API List API.
baseUrl String The base URL starting with "https://" that will be used with the API.
path String The API path, such as "records.json".
The baseURL + path will become the URL of the API.
httpMethod String The HTTP method for the API
request Object The schema information for the API request, in a JSON Schema format.
response Object The schema information for the API response, in a JSON Schema format.
schemas Object The schema information common within all APIs.
The key represents the string of the Schema information.

Sample Response

About JSON Schemas

The above JSON Schema used for request, response and schemas follows draft v4. core and validation are used, but hyper schema is not used.

type and format

To represent the limits used for the parameters of kintone, the below formats are used in addition to the formats in the JSON Schema.

type format Description
string long An integer within the range of -9223372036854775808 to 9223372036854775807.
string locale Strings of "", "en", "ja" or "zh".
string boolean Strings of "true" or "false".
string email Strings in an Email format.
string number Real data type
string query kintone query format.Check here for more data on query formats.
string date-time Date and time string in ISO format.
string timezone String representing time-zone.

*More custom kintone formats may be added in the future.

About File APIs

Upload File API (POST /k/v1/apis/json )

The request object in the JSON Schema contains custom kintone formats, but the API request will need to be sent as a Multipart format.

Download File API (GET /k/v1/apis/json )

The response object in the JSON Schema is empty, but a file will be downloaded when the API is used.

Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.