Skip to content
English
Contact Us
Go to the JobNimbus Toolbox
  • There are no suggestions because the search field is empty.

How Do I Create an API Key?

Learn how to create an API key in Settings and copy it to connect a third-party integration.

On This Page

An API key is a unique code that lets third-party software connect to your JobNimbus account. The key gets its permissions from the Access Profile you assign to it.

Creating an API Key

  1. Click on your profile icon or initials in the top right corner. Then, select Settings from the dropdown menu.

  2. In the Settings menu on the left-hand side, select the API option. 

  3. Select + Create New at the top right of the page.

  4. Enter a description for the key, such as the name of the software you're connecting. 

  5. Select an Access Profile for the key.

  6. Select Create.

  7. Copy your API Key by clicking Copy.


  8. Paste the key into the third-party software to complete the integration. Use the full API key, not the Key ID shown in your list of keys.

Important: This is the only time you will be able to see and copy this API key. Please copy it now and store it securely. If you do not copy it now from this screen you will not be able to later. You would need to create a new one to use instead.

A key keeps the permissions its Access Profile had when you created it. If you change that Access Profile later, create a new key to use the updated permissions. Check out what it means to assign an API key an Access Profile to choose the right permissions.

API Key vs. Key ID

Your list of keys shows a Key ID for each key. The Key ID is a short reference code that contains dashes. It identifies the key inside JobNimbus, but it isn't the key itself, and it won't connect an integration.

Your API key is a much longer string of 130 characters or more. You see it only once, on the screen that appears after you select Create.

If an integration returns a 401 error or says authentication failed, check whether the Key ID was pasted in place of the API key. If you don't have the full API key saved, create a new API key and paste that key into the software instead.

API Key Expiration

New API keys expire one year after you create them. You'll see the expiration date when you create the key and on the API Key Management page. When a key expires, integrations using it stop connecting to JobNimbus, so create a new key and replace the old one before that date. 

Legacy API Keys

Keys created before September 18th 2026 are legacy API keys, these keys will also expire. Once they do expire, they will need to be replaced with a new key. You can disable a legacy key, but you can't create a new legacy key or edit an existing one. To change the key an integration uses, create a new API key and replace the old key in that software. If an integration doesn't accept a new API key, contact JobNimbus Support.