API keys

This page is for developers. An API key is a secret password that lets another app make short links and read your Stackly data for you. For example, your web developer could add it to your online shop so each new product gets a short link by itself. If you don't work with a developer, you can skip this page.

Open API keys Growth+

1. Click your name at the bottom of the left menu.
2. Click Preferences.
3. In the settings menu, click API Keys.

Create a key

1. Click Generate New Key.
2. Give it a name in Key Name / Identifier, for example "Online shop". Use a name that says where the key is used.
3. Click Generate Key.

Copy a key

1. On the key's card, click Reveal to see it, or click Copy Key to copy it.
2. Give it to your developer over a safe channel, not in a public group or email chain.

Turn a key off, rotate it or delete it

• Turn off: use the switch on the card. It shows Disabled, and apps using it stop working until you turn it on again.
• Rotate: click Revoke / Rotate API Key, then Revoke Access. The old key stops working at once and you get a new one. Send the new key to your developer.
• Delete: click Delete Key and confirm. The key is gone for good.

caution

Revoking or deleting a key can't be undone. Any app using the old key stops working straight away.

Keep your key secret

• Anyone with your key can make and change links in your account.
• Don't paste it in chats, screenshots or website code that visitors can see.
• If you think someone else has it, rotate it at once.

Good to know

• API keys are on Growth and higher plans. On Free and Starter, the page asks you to upgrade.
• Each key has full access to your workspace.
• Developers can find the reference on the Stackly API docs page.