Command Palette

Search for a command to run...

Squarespace connector — API key + plan tier

Squarespace API key setup, plan-tier requirements, and what each scope unlocks during a migration to Insites.

Squarespace gates the API behind its paid plans. Once the site is on a Business or Commerce plan, you generate a single API key with one or more permissions. The Insites migration only reads — Studio never writes back.

Generate the API key#

  1. Sign in as the site owner

    Sign in to Squarespace as the site owner (admin/contributor accounts cannot generate API keys).

  2. Open Developer Tools → API Keys

    Open the site's settings, then go to Developer Tools → API Keys.

  3. Create the key

    Click Generate Key. Name it Insites Studio.

  4. Set the permissions

    Tick the permissions in the next two tables — set each to Read.

  5. Copy the key

    Copy the generated key and paste it into the connector form along with the site URL (e.g. yoursite.com or yoursite.squarespace.com).

Required (always tick these)#

These are the commerce endpoints. The connector cannot complete a commerce migration without them. Content-only sites (no shop) will get a partial connection but will skip these blocks.

ScopeModuleWhy we need it
InventoryEcommerceStock levels per SKU. Required for any commerce site so the migrated store doesn't start with unknown inventory.
OrdersEcommercePast orders with customer info, line items, and totals. Becomes Insites order history on day one.
ProductsEcommerceProducts with variants and images. The catalog. Without it the migrated store has nothing to sell.
ProfilesCRMCustomer profiles become CRM contacts on the new instance. Required so customer history isn't lost.
TransactionsEcommercePayment metadata associated with orders. Needed for refund reconciliation in the migration window.

Tick this if the site collects leads through Squarespace's built-in forms.

ScopeModuleWhy we need it
Form submissionsFormsContact form submissions captured by Squarespace. Without it, lead history is lost — usually critical for service-based sites.

What's not in the API#

Squarespace's API is narrower than Shopify or Webflow. Several things have to be migrated through the public-HTML scrape pipeline rather than the API:

  • Pages and blog posts — pulled via the storefront crawler we use for every platform. Not exposed in the official API.
  • Site design / theme — Squarespace doesn't expose theme config. The migration recreates layout from the rendered HTML and from the design tokens we extract.
  • Site assets in the Files area — pulled from rendered page HTML and downloaded through the asset pipeline.

Token storage (alpha)#

The API key is kept in your browser's localStorage so a refresh or shared link doesn't lose the migration session. It's sent to the Insites server only at the moment of a connection test or import run, and is never logged. Before GA we'll switch to a server-side token exchange so the key never touches the browser.

Delete the API key from Developer Tools → API Keys after the migration completes — see other connector guides.