KoBoToolbox has a number of advanced features built in based on our open source libraries, which include useful add-ons for advanced use cases. We're constantly working on making it easier to use them.

REST Services

You can link your data collected with KoBoToolbox to other servers or services you might own. For example, enter a server URL where a json version of your data should be POSTed. For an example of how to link your project with Openfn, see this post.

API

KoBoToolbox has two APIs for its primary tools, kpi and kc. Originally kc was the only api for deploying forms and retrieving data. Now, kpi is the primary API that should be used. 

The base URL depends on the server you are using: for most users it is https://kf.kobotoolbox.org or https://kobo.humanitarianresponse.info. Below we only use [kpi-url] to refer to this base URL.
 
API Token:
To find your API token go to
 https://[kpi-url]/token/?format=json

 To test it use this command:

curl -X GET https://[kpi-url]/api/v1/forms -H "Authorization: Token [your_token_goes_here]"

For more details on using the API follow these endpoints (selection only): 

  • https://[kpi-url]/assets/ (list of all assets, including forms/projects, questions, blocks, templates; for each asset there are several additional sub-endpoints)
  • https://[kpi-url]/submissions/ (access submitted data)
  • https://[kpi-url]/exports/ (create or view data exports)

Did this answer your question?