Generating API tokens

Article Number:040471

API tokens are strings used for authenticating Kintone REST API requests sent from external programs.

Specifying an API token in the "X-Cybozu-API-Token" header of your REST API request authenticates the request, and the API is executed. If you want to specify multiple API tokens, separate them using commas.

Example of a REST API request with 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 using multiple API tokens to look up a customer name:

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 details on authentication using API tokens, refer to the User authentication section in the following page:
API token authentication

Generating API tokens

  1. Click the App settings icon (the gear-shaped icon) at the upper right of the View screen.
    スクリーンショット:[アプリを設定]アイコンが枠線で強調されている

  2. Select the App settings tab in App settings, then click API token under Customization and integration.

  3. On the API token screen, click Generate.
    スクリーンショット:[生成する]ボタン

  4. For the generated API token, select the checkboxes under Permissions for the actions you want to allow.スクリーンショット:許可する操作のチェックボックス

  5. If necessary, add notes for the API token by clicking the Edit icon for the Notes input field.
    You can use this field to enter information useful for managing the API token, such as the purpose of the API token or a contact person.
    スクリーンショット:[メモ]を枠線で強調している

    • You can enlarge the input field horizontally and/or vertically by dragging its lower right corner with your mouse.
    • You can enter up to 200 characters.
  6. Click the Save icon (the check mark) to save your notes.
    スクリーンショット:[保存]アイコン

  7. Click Save at the bottom right of the screen.

  8. Click Update app at the upper right of the screen.

  9. On the Update app dialog, click Update app.