Note: While our most popular guides have been translated into Spanish, some guides are only available in English.

Squarespace API keys

An API (Application Programming Interface) lets developers build integrations and applications that can connect to your Squarespace site.

In this guide, you’ll learn about the Squarespace API and unique API keys.

This guide provides a general overview of Squarespace API keys. For detailed information, visit the API developer documentation.

For help with Zapier, visit Adding form integrations with Zapier.

The Squarespace API is a Premium feature:

  • Forms API (for Zapier integration) is available on Business and Commerce plans.
  • Orders API is available in the Commerce Advanced plan.
  • Inventory API is available in the Commerce Advanced plan.
  • Transactions API is available in the Commerce Advanced plan.

About our API

What you can build

With our API, you can build direct integrations with other software. Create a Forms API key to use our integration with Zapier, or create an Orders, Inventory, or Transactions API key to build your own custom Commerce tools. 

Using the data we provide access to through our API, you can:

  • Connect to a third-party fulfillment or shipping application
  • Sync your inventory with other sales channels or inventory management systems
  • Send order confirmation emails through third-party software
  • Automate shipping label printing
  • Automate accounting
  • Connect to our Zapier integration
Note: Our API doesn’t currently support OAuth authentication for third-party apps.

API key security

Your unique API key is a randomized string of characters which permits authenticated access to your Squarespace account.

To create a new key:

  1. In the Home Menu, click Settings, then click Advanced.
  2. Click Developer API Keys.
  3. Click Generate Key.
  4. Enter a Key Name.
  5. Under Permissions, check Orders, FormsInventory, or Transactions. Forms are available in the Business plan or higher. OrdersInventory, and Transactions are only available in the Commerce Advanced plan.
  6. Select the permissions for the API key
  7. Click Next.
  8. Copy your unique API key.

When you get this key:

  • Keep it secure. Treat your API key like you would treat any account password.
  • Copy and save it for your records. For security, we don’t store your API key. There’s no way to retrieve it after you close the window, but if you lose it, you can always create a new one.

You can follow these steps again to create multiple keys.

Zapier integration

You can connect Form Blocks, Newsletter Blocks, and Cover Page forms to the online automation tool Zapier. This lets you create Zaps, a type of automated workflow, which use form submissions to trigger additional Zapier integrations like Slack, Trello, ConvertKit, Salesforce and more. This can help you save time by connecting Squarespace to useful tools and automating processes.

For help, visit Adding forms integrations with Zapier.

Commerce APIs

Use the Commerce APIs to sync your store's order, inventory, and transaction data with third-party services. This is a great way to connect your Squarespace store with other services you use to manage your business, and automate key tasks like shipping and tax filing. Learn more about using these APIs in our developer documentation:

  • Inventory API - Sync your Squarespace inventory with inventory management systems.
  • Orders API - Sync your Squarespace orders with shipping and fulfillment services.
  • Transaction API - Sync your Squarespace transactions and donations with accounting services.

It's not possible to use the Commerce API to connect a third-party payment processor. You can only use Stripe, PayPal, or Square for Point of Sale to process orders made on your site.

Revoke an API key

To revoke an API key, delete it in the Squarespace API Keys panel:

  1. In the Home Menu, click Settings, then click Advanced.
  2. Click Squarespace API Keys.
  3. Click the trash can icon beside the API Key you want to revoke.
  4. Click Confirm.

Deleting an API key breaks the connection between your site and the app or service using the key to access your site data. The app or service may still have data you sent while the API was connected. Contact the developer directly to manage your historical data.

FAQ

Can I build an integration using the API?

Our APIs support a wide variety of use cases. To confirm that an integration is possible, visit our developer documentation.

What third-party integrations are available for the Orders and Inventory APIs?

The Orders and Inventory APIs are designed for merchants to build their own custom integrations. View official extensions built by third-party services in Squarespace Extensions.

Troubleshooting and support

Troubleshooting APIs falls outside the scope of Squarespace support, but you can use these as first steps when troubleshooting API issues:

  • Ensure you’re using the right type of API key. For example, you can only use the Forms API to build form integrations.
  • If a particular form or order doesn’t appear, ensure you created the API key for the correct site.
  • If a form doesn’t appear in Zapier and the API key is for the correct site, delete the form in Squarespace and add a new one.
Tip: If you’re a developer, visit the API documentation.

CORS errors

You’ll see a CORS (Cross Origin Resource Sharing) error if you use JavaScript to make requests from your website or app, because your API is present in the source code. All requests must originate from a server side application where the API key can remain secure. We don’t support CORS requests.

Was this article helpful?
9 out of 22 found this helpful