Generated by API Evangelist
Written by API Evangelist tooling for Squarespace's API. It is a proposal applied on top of the contract, not a document Squarespace publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Commerce Websites API
version: 1.0.0
extends: openapi/squarespace-websites-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/1.0/authorization/member'].get
update:
x-apievangelist-phrasing:
intent: Look up the member who owns my OAuth token
effect: read
questions:
- Which Squarespace member account does my OAuth token belong to?
- Can I see basic details about the person who authorized my app?
instructions:
- text: Get the member details for the owner of my OAuth token, sending user agent {user_agent}.
slots:
user_agent: header.User-Agent
- text: Tell me who the authorizing member is for my current OAuth connection.
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/authorization/website'].get
update:
x-apievangelist-phrasing:
intent: Look up the website that owns my key or token
effect: read
questions:
- What website is my API key or OAuth token issued for?
- Can I fetch basic details about the site my credentials control?
instructions:
- text: Get the website profile for my API key, sending user agent {user_agent}.
slots:
user_agent: header.User-Agent
- text: Show the basic website details tied to my current credentials.
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/commerce/store_pages'].get
update:
x-apievangelist-phrasing:
intent: List the store pages on my website
effect: read
questions:
- Which store pages exist on my website?
- How can I page through every store page on a site with lots of shops?
instructions:
- text: List all store pages on my website.
- text: Fetch the next page of store pages starting at cursor {cursor}.
slots:
cursor: query.cursor
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.