{"id":23977,"date":"2026-07-13T09:14:13","date_gmt":"2026-07-13T03:44:13","guid":{"rendered":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/?post_type=article&p=23977"},"modified":"2026-08-14T07:49:21","modified_gmt":"2026-08-14T02:19:21","slug":"api-key-generation","status":"publish","type":"article","link":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/article\/api-key-generation\/","title":{"rendered":"API Key Generation"},"content":{"rendered":"

Overview<\/h2>\n

An API key is a secure token that lets an Administrator authenticate requests to the Nimble REST APIs for Organization-level Integration Resources<\/strong> \u2014 such as Users, Projects, and Team Members. Using this key, you can programmatically access Nimble data from your own applications or integration tools, without signing in through the web interface each time.<\/p>\n

API key generation is one part of using the Nimble REST API<\/strong>. For an overview of the REST API and how to authenticate your requests, see Nimble REST API<\/a>.<\/p>\n

Navigation<\/h2>\n

In the left panel, select Account Space<\/strong>. Then, from the top panel, go to Administration<\/strong> and select API Key Generation<\/strong>.<\/p>\n

\"Navigate<\/a><\/p>\n

Generate an API Key<\/h2>\n

The API Key Generation screen opens with an Expiry date<\/strong> field and the Generate API Key<\/strong> button.<\/p>\n

\"API<\/a><\/p>\n

    \n
  1. Click the Expiry date<\/strong> field and select the date on which you want the key to stop working. The key remains valid until the end of this date.\"Select<\/a><\/li>\n
  2. Click Generate API Key<\/strong>.<\/li>\n
  3. Your new API key is generated and displayed. Click the Copy<\/strong> icon next to the key and store it in a safe place.\"API<\/a><\/li>\n<\/ol>\n

    How It Works<\/h2>\n

    The generated key is shown only once<\/strong>, at the time of generation. For security, Nimble does not store or display it again \u2014 so make sure you copy and save it before leaving the screen. If you lose the key, generate a new one.<\/p>\n

    The key stays active until the expiry date<\/strong> you set. After that date, any request made with the key is rejected, and you need to generate a new key to continue.<\/p>\n

    Use the API Key with the Nimble REST APIs<\/h2>\n

    Once you have your API key, you use it to authenticate calls to the Nimble REST API for Organization-level Integration Resources. You can also explore and try every available API from the interactive Swagger documentation page. For the full steps, see Nimble REST API<\/a>.<\/p>\n

    Important Points<\/h2>\n