Guide: Setting up and Using Squarespace API Keys
The Squarespace API enables developers to create integrations and applications that connect with Squarespace sites. This guide covers essential information about API keys, their setup, and usage.
API Availability by Plan:
- Forms API: Core, Plus, Advanced, Business, Commerce Basic, and Commerce Advanced plans
- Orders API: Core, Plus, Advanced, and Commerce Advanced plans
- Inventory API: Core, Plus, Advanced, and Commerce Advanced plans
- Transactions API: Core, Plus, Advanced, and Commerce Advanced plans
What You Can Build:
- Connect to third-party fulfillment or shipping applications
- Sync inventory across sales channels
- Automate order confirmation emails
- Streamline shipping label printing
- Automate accounting processes
- Enable Zapier integration
Creating an API Key:
- Navigate to Developer Tools panel
- Click Developer API Keys
- Select Generate Key
- Name your key
- Choose permissions (Orders, Forms, Inventory, or Transactions)
- Click Next
- Copy and securely store your unique API key
Security Best Practices:
- Store the key securely like any password
- Keep a backup copy (Squarespace doesn't store API keys)
- Create multiple keys as needed
Zapier Integration: Connect Forms block, Newsletter block, and Cover Page Form to automate workflows with services like Slack, Trello, ConvertKit, and Salesforce.
Commerce API Features:
- Inventory API: Sync inventory management
- Orders API: Manage shipping and fulfillment
- Products API: Product management
- Transactions API: Accounting service integration
- Webhook Subscription API: Site notifications
Limitations:
- Cannot connect to third-party payment processors
- Limited to Square, Stripe, or PayPal for order processing
Revoking an API Key:
- Open Developer Tools
- Access Developer API Keys
- Click trash icon beside the key
- Confirm deletion
Troubleshooting Tips:
- Verify correct API key type for your integration
- Confirm API key is linked to correct site
- For form issues, try deleting and recreating the form
For detailed technical documentation and support, consult the Squarespace developer site.