R Client for 'kintone' API

Retrieve data from 'kintone' (< https://www.kintone.com/>) via its API. 'kintone' is an enterprise application platform.

Retrieve data from kintone via its API. kintone is an enterprise application platform.

Stable CRAN version


Dev version


To use kintone API, kntnr needs the following environmental variables.

  • KNTN_URL: kintone URL
  • KNTN_AUTH_TYPE: authentication type (password or token)
  • KNTN_AUTH: API token or BASE64 encoded login name and password

kntn_set_auth() sets these environmental variables interactively.

# password-based authentication
# token-based authentication
kntn_set_auth(auth_type = "token")

To set another information, run kntn_set_auth() with overwrite = TRUE.

kntn_set_auth(overwrite = TRUE)

Or, unset the environmental variables by kntn_unset_auth().


You can define the environmental variables in .Renviron, which is loaded at the start of an R session. For more information, see ?Startup.

KNTN_URL = https://example.kintone.com/
KNTN_AUTH = 1234567890

kntn_record() gets a single record from the specified kintone application. kntn_records() retrieves multiple records at once. If the number of records is more than records_per_request (the default is 100), kntn_records() automatically splits the request into smaller subrequests.

app <- 10
# get a single record
d <- kntn_record(app, id = 1)
# get records up to 1000 (default)
d <- kntn_records(app)
# get records up to 5000 records at the latency of 500 records/request.
d <- kntn_records(app, max_records = 5000, records_per_request = 500L)

Some types like SUBTABLE are converted as nested data.frame. You can unnest them by using kntn_unnest().


kntn_file() gets a file from kintone API and try to parse it with httr::content(). If you want to parse it by yourself, specify as = "raw" or as = "text".

d <- kntn_record(app, id = 1)
f <- kntn_file(app, fileKey = x$Attachment[[1]]$fileKey[1])


kntnr 0.4.0

  • First release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.


0.4.1 by Hiroaki Yutani, 3 months ago


Report a bug at https://github.com/yutannihilation/kntnr/issues

Browse source code at https://github.com/cran/kntnr

Authors: Hiroaki Yutani [aut, cre]

Documentation:   PDF Manual  

MIT + file LICENSE license

Imports base64enc, dplyr, httr, jsonlite, lazyeval, lubridate, methods, purrr, rstudioapi, stringr, tibble

Suggests testthat, tidyr

See at CRAN