Generating API Tokens

Article Number:040471

API tokens are used to authenticate Kintone REST API requests that are sent from external programs.
Specifying an API token for the "X-Cybozu-API-Token" header of a request authenticates the request and executes the API. You can also specify a comma-separated list of multiple API tokens.

Example of a request that uses an API token:
GET /k/v1/record.json?app=7&id=100 HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-API-Token:cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX
Example of looking up a customer name using multiple API tokens:
curl -X POST -H "X-Cybozu-API-Token: cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX, 6oDAV8hCY6HTa1AC6EZbNe2dpc1t8QnWZrHOMgMb" "https://subdomain name.kintone.com/k/v1/record.json" -H "Content-Type: application/json" -d '{app: 20, record: {"Customer Name": {value: "kintone Research"}}}'

For more details on the authentication with API tokens, refer to the following page:
Kintone REST API Overview (Kintone Developer Program)

Steps to Generate API Tokens

  1. Click the app settings button Setting button on the upper right side of the "View" screen, select the App Settings tab, and then select API Token under Customization and Integration.

  2. Click "Generate". Image

  3. Select the check boxes of actions to be allowed for the generated API token. Image

  4. You can add notes on each API token by clicking Edit button Edit button, if necessary.
    You can use this field to write down the purpose of use, contact person and so on, which enables you to manage API tokens in your environment more easily. Image

    • You can enlarge the input field horizontally and/or vertically by dragging the lower right corner of it using the mouse.
    • You can enter up to 200 characters.
  5. After adding the notes, click Save Save button to save it. Image

  6. Click Save on the upper left side of the screen.
    The setting of the API token is saved.

  7. To apply the saved setting to the actual environment, click Update App on the upper right side of the screen.