Websites

Retrieve List of Websites

GET

https://api.squarespace.com

/reseller/v1/websites

Returns a paginated list of websites provisioned by the reseller, optionally filtered by website ID, Squarespace website ID, or customer ID.

Retrieve List of Websites › query Parameters

id

string · uuid

Filter by internal website UUID.

sqspWebsiteId

string

Filter by Squarespace website ID.

customerId

string · uuid

Filter by customer UUID.

offset

string

Pagination cursor returned in the previous response's nextPageUrl. Omit to retrieve the first page. Do not construct this value manually.

limit

integer · int32 · min: 1 · max: 100

Maximum number of websites to return per page. Defaults to 20. Clamped to [1, 100].

Default: 20

Retrieve List of Websites › Headers

Authorization

string · required

API key or OAuth access token

Default: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN

User-Agent

string · required

User Agent

Default: YOUR_CUSTOM_APP_DESCRIPTION

Retrieve List of Websites › Responses

Paginated list of websites.

Paginated list of websites provisioned by the reseller.

WebsitesResponse

nextPageUrl

string

URL for the next page of results. null if this is the last page.

WebsiteWithInternalInfo[]

List of websites for the current page.

GET/reseller/v1/websites

curl https://api.squarespace.com/reseller/v1/websites \
  --header 'Authorization: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN' \
  --header 'User-Agent: YOUR_CUSTOM_APP_DESCRIPTION'

Example Responses

{
  "websites": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sqspWebsiteId": "5f4e3d2c1b0a9876",
      "url": "https://my-website.squarespace.com"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "sqspWebsiteId": "6a5b4c3d2e1f0987",
      "url": "https://another-website.squarespace.com"
    }
  ],
  "nextPageUrl": "/reseller/v1/websites?offset=eyJ1dWlkIjoiYjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjAxMjM0NTY3ODkwIiwiaW5zdGFudCI6IjIwMjQtMDYtMDFUMTI6MDA6MDAuMDAwMDAwWiJ9&limit=20"
}

json

Websites page

application/json

Retrieve Single Website

GET

https://api.squarespace.com

/reseller/v1/websites/{id}

Retrieve a single website previously provisioned by the reseller.

Retrieve Single Website › path Parameters

id

string · uuid · required

UUID of the website to retrieve.

Retrieve Single Website › Headers

Authorization

string · required

API key or OAuth access token

Default: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN

User-Agent

string · required

User Agent

Default: YOUR_CUSTOM_APP_DESCRIPTION

Retrieve Single Website › Responses

Website found.

A website provisioned by the reseller.

WebsiteResponse

id

string · uuid

Unique identifier of the website.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

screenshotUrl

string

URL of the website's screenshot.

Example: https://screenshots.squarespace.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg

sqspWebsiteId

string

Squarespace internal website identifier.

Example: 5f4e3d2c1b0a9876

title

string

Title of the website.

Example: My Website

url

string

Public URL of the website.

Example: https://my-website.squarespace.com

websiteManagementUrl

string

URL to manage the website on Squarespace.

Example: https://my-website.squarespace.com/config

websiteStatus

WebsiteStatus · enum

Current provisioning status of a website.

Enum values:

INACTIVE

PAID

ACTIVE

PUBLISHED

UNKNOWN

Domains Events