🛒 Supported on all platforms
💳 Available on the Plus plan
👤 Accessible to all roles
API keys provide programmatic access to your Smile account and data. They can be used to connect outside integrations, sync data to external systems and databases, and to interact with Smile's REST API.
For accessing and integration with Smile.js (our JavaScript SDK), use your Public Key and Private Key instead.
Find your API keys
To view a list of existing API keys for your account:
In Smile Admin, navigate to Settings -> Developer tools.
Find the card titled Manage API keys.
If your account has created any API keys, they'll be listed within this card. To see the specific permissions (access scopes) that an API key has, click View access beside the API key's name.
ℹ️ Note: For security reasons, it is only possible to view an API key's full value immediately after it is created. If you need this value again in future, we recommend creating a new API key.
Create an API key
To create a new API key:
In Smile Admin, navigate to Settings -> Developer tools.
In the Manage API keys card, click Generate new API key.
Fill in the Name field with a value that represents how and where the API key will be used (e.g. "data warehouse" or "mobile app").
Select one or multiple access scopes for the API key.
These will determine what type of data the API key can see or modify within your account. We recommend giving each API key only the minimum set of access scopes it needs.
Click Generate.
Copy the provided API key value to a safe place.
💡 Important: For security reasons, you won't be able to see the API key value again after the initial creation, so make sure to save it in a safe place! We recommend a password manager like 1Password.
Edit an API key
For security reasons, it is not possible to edit the name or change the access scopes for an API key after it has been created.
✅ Tip: If you need to change the name or access scopes for an API key, just create a new API key instead, and then delete the old API key.
Delete an API key
To delete an existing API key:
In Smile Admin, navigate to Settings -> Developer tools.
In the Manage API keys card, locate the API key that you wish to delete.
Beside the key you wish to delete, click the delete icon.
In the modal, type the full name of the API key and click Permanently delete.
🛑 Caution: Once an API key is deleted, it will immediately stop functioning. Be sure to update any external systems or integrations using the API key before deleting the API key itself.