Overview Authentication and permissions Making requests Retrieve basic site information

Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ

Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities

Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order

Overview About product attributes Managing attributes POST: Create a product POST: Create a product variant POST: Upload a product image GET: Retrieve all Store Pages GET: Retrieve all products GET: Retrieve specific products GET: Product image upload status POST: Assign a product image to variant POST: Reorder a product image POST: Update a product POST: Update a product variant POST: Update a product image DEL: Delete a product DEL: Delete a product variant DEL: Delete a product image

Overview GET: Retrieve all profiles GET: Retrieve specific profiles

Overview GET: Retrieve all transactions GET: Retrieve specific transactions

Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

Retrieve basic site information

GET https://api.squarespace.com/{api-version}/authorization/website

Websites on Squarespace can have many API keys or OAuth tokens, though a given API key or OAuth token can only belong to one website. Use the Authorization API endpoint to identify which website is associated with an API key or OAuth token. The response provides basic site information to aid in development when using Commerce APIs.

Parameters

{api-version} string
required

The current version for the Authorization API is 1.0.

Request example

curl "https://api.squarespace.com/1.0/authorization/website" \
  -i \
  -H "Authorization: Bearer YOUR_SECRET_API_KEY" \
  -H "User-Agent: YOUR_PRODUCT / YOUR_PRODUCT_VERSION" \
  -H "Content-Type: application/json"

If you're new to Commerce APIs, read the Making requests guide to learn more about how to access this endpoint.

Response example

A successful request generates a response in JSON.

{
  // Id of the website that owns the API key or OAuth.
  "id": "5863f6faf7e0abc3cf95ce3a",

  // Identifier, or subdomain, of the website within squarespace.com.
  "siteId": "developers",

  // The website's title.
  "title": "Squarespace Developers",

  // The website's canonical URL, which specifies the website's custom domain when available.
  "url": "https://developers.squarespace.com",

  // The currency the website uses for commerce needs.
  // Configured in "Commerce > Payments".
  "currency": "USD",

  // The measurement standard the website uses for commerce needs, such as product dimensions.
  // Possible values are 'IMPERIAL' and 'METRIC'.
  // Configured in "Settings > Language & Region" in the Squarespace UI.
  "measurementStandard": "METRIC",

  // An ISO language and country code associated with the website.
  // This doesn't reflect the language shown to users in the Squarespace UI.
  // Configured in "Settings > Language & Region" in the Squarespace UI.
  "language": "en-US",

  // The time zone associated with the website.
  // Configured in "Settings > Language & Region" in the Squarespace UI.
  "timeZone": "America/New_York",

  // Physical business location information associated with the website;
  // object doesn't include street address nor name of the business.
  // Configured in "Settings > Business Information" in the Squarespace UI.
  "location": {
      "region": "New York, NY, 10014",
      "country": "United States"
  }
}