Intermediate
How to generate API key for integrations on Squarespace
Quick Answer
To generate an API key on Squarespace, navigate to Settings > Advanced > API Keys, then click 'Generate API Key' and configure permissions. This requires a Business or Commerce plan and allows third-party integrations to access your site data.
Prerequisites
- Active Squarespace website
- Business or Commerce plan subscription
- Admin access to your Squarespace site
- Basic understanding of API integrations
1
Access your Squarespace site settings
Log into your Squarespace account and select your website from the dashboard. Click on Settings in the left sidebar menu. This will open the main settings panel for your site.
Tip
Make sure you're logged in as the site owner or have admin privileges to access API settings.
2
Navigate to Advanced settings
In the Settings menu, scroll down and click on Advanced. This section contains developer tools and API management options. Look for the API Keys option in the Advanced settings submenu.
Tip
If you don't see the Advanced section, verify that your site is on a Business or Commerce plan as API access requires these paid plans.
3
Open API Keys management
Click on API Keys from the Advanced settings menu. This will display your current API keys (if any) and provide options to create new ones. The interface shows active keys, their permissions, and usage statistics.
4
Generate a new API key
Click the Generate API Key button. A dialog box will appear asking you to name your API key and set permissions. Enter a descriptive name like
Third-party Integration or Analytics Tool to help identify the key's purpose later.Tip
Use descriptive names that clearly indicate which service or integration will use each API key.
5
Configure API permissions
Select the appropriate permissions for your integration:
- Read - Allows retrieving data from your site
- Write - Allows modifying content and data
- Commerce - Grants access to order and product data
Tip
Start with read-only permissions and upgrade only if your integration specifically requires write access.
6
Save and copy your API key
Click Save to generate the key. Squarespace will display your new API key once - copy it immediately using the Copy button. Store this key securely as it won't be shown again. The key format will look like:
sq-api-xxxxxxxxxxxxxxxxxxxxTip
Save the API key in a secure password manager immediately - Squarespace only displays it once for security reasons.
7
Test your API connection
Verify your API key works by making a test request to
https://api.squarespace.com/1.0/commerce/orders with your key in the Authorization header: Authorization: Bearer YOUR_API_KEY. You should receive a response confirming the connection is working.Tip
Use tools like Postman or curl to test your API key before implementing it in your integration.
Troubleshooting
API Keys option not visible in Advanced settings
Upgrade to a Business or Commerce plan. API access is not available on Personal plans. Go to Settings > Billing to upgrade your subscription.
API key returns 401 Unauthorized error
Verify the key is correctly formatted in your Authorization header as
Bearer YOUR_API_KEY. Check that your key has the necessary permissions for the endpoint you're accessing.Generated API key was lost or not copied
Delete the existing key from the API Keys panel and generate a new one. For security, Squarespace doesn't store or display keys after initial generation.
Integration receiving empty or limited data
Review and expand your API key permissions in Settings > Advanced > API Keys. Edit the key to include Read or Commerce permissions as needed for your integration.
Ready to get started with Squarespace?
Put this tutorial into practice. Visit Squarespace and follow the steps above.
Visit Squarespace →