An API key lets another system, such as your own software or a partner tool, work with your Sweeply tasks. This article shows how to create, copy and delete a key.
Before you start
You need the Admin role in Sweeply.
The API Keys tab is only shown on accounts where API access is enabled. If you don't see it, contact us in the chat.
Connecting Mara or Duve? Don't create a key here. Use Settings → Integrations instead, which creates a key with only the access that integration needs.
Create the key
Open Settings, then Account, and select the API Keys tab.
Select Create API Key.
Give the key a name that says where it will be used, for example the name of the system you are connecting. Each key needs its own name.
Select Save.
Sweeply shows API Key Created. Select Copy Key and paste the key into the other system, or store it somewhere safe, such as a password manager.
Select Close.
The key is shown only once. After you close the window you cannot see it again. If you lose it, delete the key and create a new one.
What the key can do
A key created here can create, read, update and delete tasks in your property. The Permissions column in the list shows what each key can do.
Treat the key like a password. Anyone who has it can change your tasks. Never share it in an email or chat.
Delete a key
In Settings → Account → API Keys, find the key in the list.
Select the delete icon in the Actions column, then confirm.
The key stops working at once, and any system using it can no longer reach Sweeply. This cannot be undone.
Questions
Can I see a key again after creating it? No. Sweeply only shows it once. Create a new key and delete the old one.
I think someone else has our key. What do I do? Delete the key straight away, then create a new one and paste it into the systems that should have it.
Does a key expire? No. It works until you delete it.