API keys let your own code and other tools (Make, Fivetran, Alloy and others) connect to your Retently account through the Retently API. A key works like a username and password combined, so keep it as safe as a password.
Create an API key
Go to Settings > API keys.
Click Generate New API Token.
Enter a name that tells you where the key is used, for example "Make" or "Signup form".
Choose the permissions:
Write (Full Access): can read, create, update and delete data, and send surveys.
Read Only: can only read data and cannot change anything.
Click Generate API Token.
In the Your new API token window, click Copy and paste the key into the tool you are connecting, or save it in a password manager.
Click Done.
đ IMPORTANT: The full key is shown only once, in this window. After you close it, it cannot be displayed again, by you or by our team. For security, Retently stores only the last 6 characters of each key.
Tip: Create a separate key for each tool. If one tool stops needing access, you can delete its key without affecting the others.
If you lose a key
A lost key cannot be recovered. To replace it:
Create a new key following the steps above.
Paste the new key into the tool or code that used the old one.
Delete the old key.
Manage your keys
The API keys page lists every key in your account:
Name: the name you gave the key.
Permissions: Full Access or Read Only.
Created: when the key was created.
Last used: when the key was last used for an API request. "Never" means the key has not been used since it was created. Use this to spot keys you no longer need.
API key: the last 6 characters of the key, so you can tell which key a tool is using.
To change a key's name or permissions, click the ... menu next to it and select Edit token. The key itself stays the same, so connected tools keep working.
To remove a key, click the ... menu and select Delete. Any tool or code still using that key stops working right away.
Who can manage API keys
The API keys page is available when your plan includes API access, and only to users with permission to make changes in the account. If the page says that API keys are restricted, ask an account administrator for access.