Template Docs Commerce APIs Webhooks
Get Started
Template Docs Commerce APIs Webhooks
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
Orders API
Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order
Products API
Overview About product attributes Managing attributes POST: Create a product POST: Create a product variant POST: Upload a product image GET: Retrieve all Store Pages GET: Retrieve all products GET: Retrieve specific products GET: Product image upload status POST: Assign a product image to variant POST: Reorder a product image POST: Update a product POST: Update a product variant POST: Update a product image DEL: Delete a product DEL: Delete a product variant DEL: Delete a product image
Profiles API
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

Profiles API overview

Current version: 1.0
For versioning details, read the Upgrade guide.

The Profiles API allows apps to retrieve Squarespace site users.

A site user can be a customer, mailing list subscriber, or donor that are traditionally accessible through the Profiles panel.

Site visitors become site users when they perform one of the following actions:

  • Registers an account with the site
  • Performs an e-commerce guest checkout or donation on the site
  • Subscribes to a newsletter or campaigns mailing list

API resources

The Profiles API allows for the retrieval of Profile resource objects. Every Profile contains information about a site user and has the following characteristics:

  • A unique email address
  • An approximate address for the user based on existing data (always generated internally, not created by the API)
  • A summary of the user's commerce transactions, such as orders or donations (generated asynchronously from the site)

Further reading