A Squarespace API key is a uniquely generated string that acts as a secure credential, granting external apps and services authorized access to your site’s data. Think of it as a digital key that unlocks specific doors, such as letting a third-party tool read your orders, sync your inventory, or pull your form submissions, without ever needing your Squarespace login credentials.
In this guide, you’ll learn how to get Squarespace API key via 8 steps:
- Step 1. Navigate to Squarespace admin dashboard and activate the Developer Tools panel.
- Step 2. Click the Developer API Keys option, and choose Generate Key.
- Step 3. Enter a Key Name to identify this credential
- Step 4. Check Orders, Forms, Inventory, or Transactions under Permissions.
- Step 5. Choose the permissions you need.
- Step 6. Click Next and copy your Squarespace API key.
How to Get Squarespace API Key
Before we proceed, please note that the Squarespace API key feature is only available on the Core plan and above. If your site is on a lower-tier plan, the Developer API Keys option will not appear in your settings. Therefore, make sure you have upgraded.
Now, follow these steps to generate your Squarespace API key:
- Step 1. Open the Developer tools panel in your Squarespace admin dashboard.
- Step 2. Click Developer API Keys, then select the Generate Key option.
- Step 3. Enter a Key Name for your API credential.
- Step 4. Under the Permissions section, check Orders, Forms, Inventory, or Transactions. Forms are available in the Business plan or higher. Orders, Inventory, and Transactions are only available in the Commerce Advanced plan.
- Step 5. Choose the permissions you need for your API key.
- Step 6. Click Next, and your Squarespace API key will be generated. Copy this credential and save it to a secure place for future use.
Squarespace API Key Permission
When generating a Squarespace API key, you must define exactly what data the key can access. These are called permissions, and selecting the right ones ensures your integration works correctly while keeping your store data secure. Below is a full breakdown of the available Squarespace API key permissions.
- Forms API (Read only): View form submission data; for Zapier integration only
- Inventory API:
- Read Only: View inventory stock levels
- Read and Write: Manage inventory stock levels
- Orders API:
- Read Only: View order, fulfillment, and customer information (name, email, address, and more)
- Read and Write: View customer information (name, email, address, and more); manage order and fulfillment information
- Products API:
- Read Only: View product information, including information for any images and variants; view Store Page information
- Read and Write: Manage product information, including information for any images and variants; view Store Page information
- Profiles API (Read Only): View the name, address, email, marketing preferences, and other profile information of customers, subscribers, and other website users
- Transaction API (Read Only): View transactional order, donation data, and customer information (email)
You can assign multiple permissions to a single key, but it’s recommended to create separate keys for separate integrations. This way, if one key is compromised or no longer needed, you can revoke it without affecting your other connected tools.
When Do You Need to Retrieve Squarespace API Key
Not every Squarespace user will need an API key. But if you’re looking to extend your site’s functionality beyond the built-in dashboard, it’s almost certainly required. Here are the most common scenarios where retrieving a Squarespace API key becomes necessary:
- Migrating your store: In some cases, you might need to provide your API credentials to securely transfer your products, orders, and customer data to or from Squarespace.
- Connecting automation platforms: Services like Zapier, Make (formerly Integromat), or n8n use your API key to trigger automated workflows based on Squarespace events, such as a new order being placed or a form being submitted.
- Integrating shipping software: Platforms like ShipStation or Shippo pull order data and push fulfillment updates back to your Squarespace store via the Orders API.
- Syncing inventory: Third-party point-of-sale (POS) systems or inventory management tools need API access to keep your stock levels accurate across multiple sales channels.
- Connecting marketing or CRM tools: Linking email marketing platforms (e.g., ConvertKit, Mailchimp) or customer relationship management systems to sync form submissions and customer data.
- Building custom integrations: Developers creating bespoke dashboards, internal reporting tools, or custom features that read from or write to your Squarespace store data
Troubleshoot Common Errors With Squarespace API Key
When generating Squarespace API key, you might run into several issues. Check out our troubleshooting table below to identify the causes and learn how fix them.
- Missing the API key option: Upgrade to the Core plan or above to unlock the Developer API Keys option in your dashboard
- 401 Unauthorized error: Generate a new key, copy it carefully without extra spaces, and re-enter it in the connected tool
- 403 Forbidden error: Generate a new key and assign the correct access level or the relevant permission scope
- 402 Payment Required error: Renew your Squarespace plan to restore API access
If problems persist after trying the fixes above, it is recommended to consult Squarespace support for more information and solutions.
Squarespace API Key – FAQs
Where do I find my Squarespace API key?
You can find and generate your Squarespace API by following these steps:
- Step 1. Navigate to Squarespace admin dashboard and activate the Developer Tools panel.
- Step 2. Click the Developer API Keys option, and choose Generate Key.
- Step 3. Enter a Key Name to identify this credential
- Step 4. Check Orders, Forms, Inventory, or Transactions under Permissions.
- Step 5. Choose the permissions you need.
- Step 6. Click Next and copy your Squarespace API key.
Can I get Squarespace API key for free?
No, access to the Squarespace API is not available on free or entry-level tiers. You must be on the Core plan or above to generate a Squarespace API key, and certain permissions require the Commerce Advanced plan. That said, once your plan meets the requirement, generating as many API keys as you need does not cost anything extra.
When should I get a Squarespace API key?
You should get a Squarespace API key when you need to connect your site to a third-party tool or service that requires direct access to your store data. If you're only managing your site through the Squarespace dashboard without any external integrations, you don't need one right away.
Final Words
In short, a Squarespace API key is a small but essential credential that unlocks a much bigger ecosystem for your store. Hence, having your API key set up correctly is the first step toward making your Squarespace site work seamlessly with the tools you rely on.
If you’re planning to migrate your store, whether you’re moving to Squarespace from another platform or leaving Squarespace for a new one, LitExtension is the most reliable way to do it. As the world’s #1 shopping cart migration service, we guarantee to deliver a secure and accurate Squarespace store migration with no technical skill required.
