User Manual

08.14.2026

MANUAL

Developer Function: API: Create an API Key

## Overview This section explains how to issue an "API Key" to use the "[API](https://pleasanter.org/en/manual/api)". ## What's "API Key" To use the "API" from an external program, you need to specify an "API key" so that Pleasanter can recognize who is accessing the API and with what permissions. When calling Pleasanter's "API" from outside, specifying an "API key" is mandatory. However, when accessing via a logged-in browser session, it is also possible to use the API without specifying an "API key." In this case, the API is executed with the permissions of the logged-in user. When a script or server script specifies an "API key" belonging to a user other than the logged-in user as a parameter, the API is executed with the permissions of the specified user. The time values retrieved via the "API" are converted to the time zone set by the user who created the "API key." ## Notes 1. If the "API Key" is leaked, it may be possible to access it from an external program. Please keep the "API Key" securely and do not let others know. ## Operation Procedure 1. Click on "[User](/en/manual/table-management-choices-text-users)" - "API Settings" from the navigation menu. ![image](https://pleasanter.org/binaries/9e404f2969d7462da79502ecb48677e2) 1. Click the "Create" button. ![image](https://pleasanter.org/binaries/b5ba7c299ad84ebab6357f6182315e01) 1. The string displayed in "API Key" is your API key. ![image](https://pleasanter.org/binaries/319f02e8241b47a7abee1e5f88964b4a) ## Related Information <div id="ManualList"><ul><li><a href="/en/manual/table-management-choices-text-users">Table Management: Editor: Item Detail Settings: Option List: User</a><span>08.13.2024 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
code VS Codeで開発作業をもっとスマートに

スクリプト開発の効率を高めたい方に、Code Assistをご用意しています。

Code Assistの詳細はこちら →
account_tree 複雑な構成も、すっきり視覚化

サイト構成やデータのつながりを可視化し、把握しやすくします。

Site Visualizerの詳細はこちら →
TOP