Kintone API Documentation

This is the complete API documentation for connecting to the Kintone API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Kintone: Kintone: Build, manage, and automate custom business apps. Keep reading to get started.

Quickstart

Before you run your first Kintone request, you need three things:

A MindCloud account — sign in or create an account at MindCloud.
A MindCloud API Key — create one in API Keys. Keep it on your server.
At least one Kintone connection — create or choose one in Connections. Note its connectionId.

Every Kintone action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/kintone/latest/actions/{actionSlug}

You need a MindCloud API Key and a Kintone connection. Then call an action such as Download File:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/kintone/latest/actions/download-file" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Kintone account that should run the action. MindCloud stores and refreshes the Kintone credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Connect Kintone with OAuth 2.0

You need admin access to the Kintone tenant you plan to connect. The Base URL in the connection form must be the same Kintone tenant that owns the OAuth client configured for this app.

Open Kintone OAuth client settings
In Kintone administration, open OAuth settings and create a new OAuth client or open the existing one used for this app.
Kintone administration → OAuth
Set the redirect endpoint
Add this callback URL to the OAuth client exactly: https://api.mindcloud.co/v1/oauth/kintone/callback.
Allow the right users to authorize
In Configure users, allow the Kintone users who should be able to complete the OAuth consent flow.
OAuth client → Configure users
Grant the required scopes
Grant these scopes on the OAuth client: k:app_settings:read, k:app_record:read, k:app_record:write, k:file:read, and k:file:write.
Kintone Developer Program → Authentication → OAuth Permission Scopes
Enter the tenant Base URL in the connection form
In the connection form, enter the full tenant URL in the format https://your-subdomain.kintone.com, making sure it is the same tenant where the OAuth client was created, then click Connect.

Kintone actions

All 24 published actions for this Kintone version. Each page documents the endpoint, arguments, and response controls.

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

Quickstart

Authentication

Connect Kintone with OAuth 2.0

Kintone actions

Related apps