Squarespace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Squarespace Profiles API

5 actions 5 updates phrasing extends openapi/squarespace-profiles-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/1.0/profiles'].get

$.paths['/1.0/profiles/{profileIdCsvs}'].get

$.paths['/profiles'].get

$.paths['/profiles/{profileIds}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Squarespace Profiles API
  version: 1.0.0
extends: openapi/squarespace-profiles-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: 4
- target: $.paths['/1.0/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List and sort profiles (1.0)
      effect: read
      questions:
      - How do I list customer profiles sorted by last name using the versioned 1.0 API?
      - Can I filter 1.0 profiles to only those who are customers or have accounts?
      instructions:
      - text: List 1.0 profiles sorted by {sortField} in {sortDirection} order.
        slots:
          sortField: query.sortField
          sortDirection: query.sortDirection
      - text: List 1.0 profiles using filter {filter}.
        slots:
          filter: query.filter
      - text: Find the 1.0 profile with email {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles/{profileIdCsvs}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get specific profiles by ID (1.0)
      effect: read
      questions:
      - How do I fetch several profiles at once by their IDs on the 1.0 endpoint?
      - How many profiles can one 1.0 by-ID request return?
      instructions:
      - text: Get 1.0 profiles {profileIdCsvs}.
        slots:
          profileIdCsvs: path.profileIdCsvs
      - text: Look up profiles {profileIdCsvs} through the versioned 1.0 API.
        slots:
          profileIdCsvs: path.profileIdCsvs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers, subscribers and donors (unversioned)
      effect: read
      questions:
      - Which of my site's profiles are customers, via the unversioned profiles path?
      - Can I list only anonymous profiles that have no Squarespace account?
      instructions:
      - text: Retrieve unversioned profiles where customer is {isCustomer}.
        slots:
          isCustomer: query.isCustomer
      - text: Retrieve unversioned profiles with account status {hasAccount}.
        slots:
          hasAccount: query.hasAccount
      - text: Find the unversioned profile matching exact email {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles/{profileIds}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get specific profiles by ID (unversioned)
      effect: read
      questions:
      - How do I retrieve particular profiles by ID without the 1.0 prefix?
      - Will the unversioned by-ID profile lookup return results in the order I sent the IDs?
      instructions:
      - text: Retrieve unversioned profiles {profileIds}.
        slots:
          profileIds: path.profileIds
      - text: Pull the profile records for IDs {profileIds} from the unversioned endpoint.
        slots:
          profileIds: path.profileIds
      method: generated
      generated: '2026-10-01'