Profiles API overview

Maintenance mode — The Profiles API is now in maintenance mode. The Contacts API is its modern replacement, adding full CRUD operations, address book management, query filtering, and webhook support. Migration to the Contacts API is highly recommended, and new integrations should use the Contacts API.

Current version: 1.0
For versioning details, read the Versioning 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)