Squarespace

Squarespace Contacts API

Manage customer contacts and address book entries for a website: create, read, update, delete, and query contacts; maintain addresses for shipping and fulfillment.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/contacts List the contacts on my website · List contacts #
Ask an LLM
“How do I list every contact stored for my Squarespace site?”
“Can I control how many contacts come back per page when listing them all?”
Tell an agent
List my website's contacts, {pageSize} per page.
Continue listing all contacts from cursor {cursor}.
POST /v1/contacts Add a new contact · Create contact #
Ask an LLM
“How do I add a new person to my site's contact list?”
“What details are required when creating a contact, like locale and primary email?”
Tell an agent
Create a contact named {firstName} {lastName} with email {primaryEmail} and locale {locale}.
Add {primaryEmail} as a new contact for {firstName} {lastName}, locale {locale}.
POST /v1/contacts/query Search and filter contacts · Query contacts #
Ask an LLM
“Which contacts have placed more than a certain number of orders?”
“Can I search contacts by name or email and sort the results?”
Tell an agent
Search contacts matching {searchString}, sorted by {sortField} {sortDirection}.
Find contacts whose order count falls within {orderCount}.
DELETE /v1/contacts/{contactId} Delete a contact · Delete contact #
Ask an LLM
“How do I remove a contact from my site entirely?”
“Can I permanently delete a single contact record by its ID?”
Tell an agent destructive · confirm first
Delete contact {contactId}.
Remove contact {contactId} from my contact list.
GET /v1/contacts/{contactId} Get one contact's details · Get contact #
Ask an LLM
“How can I pull up the full record for a single contact by ID?”
“What information is stored on one specific contact?”
Tell an agent
Get contact {contactId}.
Show me the details saved for contact {contactId}.
PATCH /v1/contacts/{contactId} Update a contact's name, email or locale · Update contact #
Ask an LLM
“How do I change the email address on an existing contact?”
“Can I update just a contact's last name without resending everything else?”
Tell an agent
Change the primary email of contact {contactId} to {primaryEmail}.
Rename contact {contactId} to {firstName} {lastName}.
GET /v1/contacts/{contactId}/address-book List a contact's saved addresses · Get address book #
Ask an LLM
“Which addresses are saved in a contact's address book?”
“How can I tell which saved address is a contact's default shipping address?”
Tell an agent
List the address book for contact {contactId}.
Show contact {contactId}'s saved addresses, {pageSize} per page.
POST /v1/contacts/{contactId}/address-book Add an address to a contact's address book · Create address book entry #
Ask an LLM
“How do I save a new shipping address for a contact?”
“Can I make a newly added address the contact's default for shipping?”
Tell an agent
Add address {address} to contact {contactId}'s address book.
Save {address} for contact {contactId} and make it default shipping: {defaultShipping}.
DELETE /v1/contacts/{contactId}/address-book/{addressBookEntryId} Delete a saved address from a contact · Delete address book entry #
Ask an LLM
“How do I remove an old address from a contact's address book?”
“What happens to the default shipping address if I delete it?”
Tell an agent destructive · confirm first
Delete address book entry {addressBookEntryId} from contact {contactId}.
Remove saved address {addressBookEntryId} for contact {contactId}.
GET /v1/contacts/{contactId}/address-book/{addressBookEntryId} Get one saved address for a contact · Get address book entry #
Ask an LLM
“How do I look up one specific saved address for a contact?”
“Is a particular address book entry marked as the default shipping address?”
Tell an agent
Get address book entry {addressBookEntryId} for contact {contactId}.
Show the saved address {addressBookEntryId} belonging to contact {contactId}.
PUT /v1/contacts/{contactId}/address-book/{addressBookEntryId} Replace a contact's saved address · Replace address book entry #
Ask an LLM
“How do I correct a typo in a contact's existing saved address?”
“Why doesn't unsetting default shipping on the current default address take effect?”
Tell an agent
Replace address book entry {addressBookEntryId} of contact {contactId} with {address}.
Make saved address {addressBookEntryId} the default shipping address for contact {contactId}, keeping {address}.

Documentation

📖
Documentation
https://developers.squarespace.com/commerce-apis/overview
📖
APIReference
https://developers.squarespace.com/commerce-apis
📖
GettingStarted
https://developers.squarespace.com/quick-start
📖
Authentication
https://developers.squarespace.com/commerce-apis/authentication-and-permissions
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/rate-limits/squarespace-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/openapi/squarespace-contacts-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/scopes/squarespace-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/errors/squarespace-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/conventions/squarespace-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/conventions/squarespace-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/data-model/squarespace-data-model.yml
🔗
ChangeLog
https://developers.squarespace.com/commerce-apis/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/squarespace:squarespace-contacts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

squarespace-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Commerce Contacts API
  version: '2'
  description: 'Manage customer contacts and address book entries for a website: create, read, update, delete, and query contacts; maintain addresses for shipping and fulfillment.'
servers:
- url: https://api.squarespace.com
  description: Commerce API
security:
- Authorization: []
tags:


# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/openapi/squarespace-contacts-api-openapi.yml