The Squarespace API enables developers to create integrations and applications that connect with your Squarespace site. Here's everything you need to know about setting up and using API keys effectively.

API Availability:

• Forms API: Available on Essential, Plus, Advanced, Business, Basic Commerce, and Advanced Commerce plans
• Orders API: Available on Essential, Plus, Advanced, and Advanced Commerce plans
• Inventory API: Available on Essential, Plus, Advanced, and Advanced Commerce plans
• Transactions API: Available on Essential, Plus, Advanced, and Advanced Commerce plans

Common API Use Cases:

• Connect to third-party processing or shipping apps
• Sync inventory across sales channels
• Automate email confirmations, shipping labels, and accounting
• Integrate with Zapier
• Create custom Commerce tools

Creating an API Key:

1. Open "Developer Tools" panel
2. Click "Developer API Keys"
3. Click "Generate Key"
4. Enter Key Name
5. Select permissions (Orders, Forms, Inventory, or Transactions)
6. Click Next
7. Copy and save your unique API key securely

API Security Best Practices:

• Store your API key securely
• Save it immediately (it can't be retrieved later)
• Create multiple keys as needed
• Treat it like a password

Available APIs and Their Functions:

• Inventory API: Sync inventory with management systems
• Orders API: Connect with shipping services and import orders
• Products API: Manage product creation and editing
• Transactions API: Sync transactions with accounting services
• Webhook Subscriptions API: Receive site notifications

Zapier Integration: Connect Form Blocks, Newsletter Blocks, and Landing Page Forms to automate workflows with popular services like Slack, Trello, ConvertKit, and Salesforce.

Revoking an API Key:

1. Open "Developer Tools" panel
2. Click "Developer API Keys"
3. Click the trash can icon next to the key
4. Confirm deletion

Note: Deleting a key breaks the connection between your site and the integrated service. Historical data may remain with the third-party service.

Troubleshooting Tips:

• Verify you're using the correct API key type
• Ensure the API key is created for the right site
• For form issues in Zapier, try deleting and recreating the form
• For detailed API documentation, visit the Squarespace Developer Site

Important Limitations:

• Commerce API cannot link to external payment processors
• Only Square, Stripe, and PayPal can process orders
• Orders and Inventory APIs are for custom merchant integrations

Related Articles

Previous Articles