Customers

Download schema

Retrieve List of Customers

GET

https://api.squarespace.com

/reseller/v1/customers

Retrieve a paginated list of customers previously created by the current seller. Optionally filter by email address.

Retrieve List of Customers › query Parameters

email

string

Filter by customer email address. Must be a valid email format. When provided, returns at most one matching customer and cursor pagination is not applied.

limit

integer · int32 · min: 1 · max: 100

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

Default: 20

offset

string

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

Retrieve List of Customers › 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 Customers › Responses

Customers retrieved successfully.

Paginated list of customers for the current seller.

Customers

Customer[]

List of customers for the current page.

nextPageUrl

string

URL to retrieve the next page of results. null when there are no further pages.

GET/reseller/v1/customers

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

Example Responses

{
  "customers": [
    {
      "customerId": "d3c4e5f6-7890-abcd-ef01-234567890abc",
      "status": "ACTIVE",
      "verificationUrl": "https://login.squarespace.com/api/1/login/confirm-account?token=abc123",
      "createdOn": "2024-01-15T10:30:00Z"
    },
    {
      "customerId": "e4f5a6b7-8901-bcde-f012-345678901234",
      "status": "PENDING",
      "verificationUrl": "https://login.squarespace.com/api/1/login/confirm-account?token=def456",
      "createdOn": "2024-01-14T09:00:00Z"
    }
  ],
  "nextPageUrl": "/reseller/v1/customers?limit=2&offset=eyJ1dWlkIjoiZTRmNWE2YjctODkwMS1iY2RlLWYwMTItMzQ1Njc4OTAxMjM0IiwiaW5zdGFudCI6IjIwMjQtMDEtMTRUMDk6MDA6MDAuMDAwMDAwWiJ9&uu=true"
}

json

Customers found with next page

application/json

Create Customer

POST

https://api.squarespace.com

/reseller/v1/customers

Create a new customer under the current seller. A Squarespace account is created and linked asynchronously — the response is returned immediately with status PENDING.

Create Customer › 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

Create Customer › Request Body

Request body for creating a new customer.

CreateCustomerRequest

email

string · required

Customer email address. Must not already be registered with Squarespace. Max 254 characters.

Example: [email protected]

firstName

string · minLength: 0 · maxLength: 250 · required

Customer first name. Max 250 characters.

Example: Jane

lastName

string · minLength: 0 · maxLength: 250 · required

Customer last name. Max 250 characters.

Example: Doe

socialAccount

string · enum · required

Defines how Squarespace will prompt the user to log in. PASSWORD indicates the customer will be asked to create and use email + password; the others are SSO options. Note customers may change their login method on the Squarespace site.

Enum values:

APPLE

GOOGLE

FACEBOOK

PASSWORD

Example: PASSWORD

acceptedAt

string · date-time

Timestamp when the customer accepted the terms of service. Required if acceptedTerms is provided.

Example: 2024-01-15T10:30:00Z

acceptedTerms

boolean

Whether the customer accepted the terms of service. Required if acceptedAt is provided.

locale

string · minLength: 0 · maxLength: 35

Preferred locale for the customer's Squarespace account. Defaults to 'en-US' if omitted. Supports formats such as 'en', 'en-US', 'es-419', 'pt-BR'. Max 35 characters.

Example: en-US

location

string · minLength: 0 · maxLength: 2 · pattern: ^[A-Z]{2}$

ISO 3166-1 alpha-2 country code for the customer's account. Used for regional settings and GDPR. Defaults to the country implied by locale if omitted.

Example: US

metadata

object

Additional key-value metadata for the customer. Keys max 50 characters, values max 255 characters.

timezone

string

Timezone for the customer's account, as a tz database identifier. Use underscores for multi-word cities (e.g. 'America/New_York').

Example: America/New_York

Create Customer › Responses

Customer created successfully. Account provisioning is in progress.

A customer account registered under the current seller.

Customer

createdOn

string

Account creation timestamp.

Example: 2024-01-15T10:30:00Z

customerId

string

UUID of the customer account, within the reseller's account

Example: d3c4e5f6-7890-abcd-ef01-234567890abc

email

string

Customer email address. Omitted from list responses.

status

string · enum

Status of the customer's Squarespace account. ACTIVE: valid and operational. PENDING: account creation in progress. SUSPENDED: pending deletion by Squarespace. TERMINATED: account deleted. FAILED: account creation failed.

Enum values:

ACTIVE

PENDING

SUSPENDED

TERMINATED

FAILED

Example: ACTIVE

verificationUrl

string

URL the customer must visit to verify their Squarespace account. This link never expires.

POST/reseller/v1/customers

curl https://api.squarespace.com/reseller/v1/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN' \
  --header 'User-Agent: YOUR_CUSTOM_APP_DESCRIPTION' \
  --data '{
  "acceptedAt": "2024-01-15T10:30:00Z",
  "acceptedTerms": true,
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "locale": "en-US",
  "location": "US",
  "metadata": {},
  "socialAccount": "PASSWORD",
  "timezone": "America/New_York"
}'

Example Request Body

{
  "acceptedAt": "2024-01-15T10:30:00Z",
  "acceptedTerms": true,
  "email": "[email protected]",
  "firstName": "Jane",
  "lastName": "Doe",
  "locale": "en-US",
  "location": "US",
  "metadata": {},
  "socialAccount": "PASSWORD",
  "timezone": "America/New_York"
}

json

Example Responses

{
  "customerId": "d3c4e5f6-7890-abcd-ef01-234567890abc",
  "email": "[email protected]",
  "status": "PENDING",
  "createdOn": "2024-01-15T10:30:00.000000Z"
}

json

Customer created

application/json

Link Customer Account

POST

https://api.squarespace.com

/reseller/v1/customers/link-account

Link an existing Squarespace account to the current seller. Use this instead of Create Customer when the customer already has a Squarespace account. This endpoint needs to be called using a token retrieved via the account-linking process – see account-linking guide

Link Customer Account › 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

Link Customer Account › Request Body

Request body for linking an existing Squarespace account to the current seller.

LinkCustomerRequest

email

string · required

Email address of the existing Squarespace account to link. Must match the account identified by the X-Member-Account-Id header.

Example: [email protected]

Link Customer Account › Responses

Account linked successfully. The status reflects the current state of the Squarespace account.

A customer account linked to the current seller.

LinkAccountCustomer

createdOn

string

Timestamp when the customer record was created.

Example: 2024-01-15T10:30:00.000000Z

customerId

string

UUID of the customer account.

Example: d3c4e5f6-7890-abcd-ef01-234567890abc

email

string

Customer email address.

Example: [email protected]

status

string · enum

Current status of the customer's Squarespace account. ACTIVE: valid and operational. PENDING: account creation in progress. SUSPENDED: pending deletion. TERMINATED: account deleted. FAILED: account creation failed.

Enum values:

ACTIVE

PENDING

SUSPENDED

TERMINATED

FAILED

Example: ACTIVE

Retrieve Customer by ID

GET

https://api.squarespace.com

/reseller/v1/customers/{customerId}

Retrieve a customer previously created by the current seller. Returns richer profile data than the list endpoint, including name, email, language, timezone, and account verification status.

Retrieve Customer by ID › path Parameters

customerId

string · uuid · required

Reseller customer ID.

Retrieve Customer by ID › 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 Customer by ID › Responses

Customer retrieved successfully.

Profile information for a reseller customer.

CustomerProfile

country

string

Country code derived from the customer's preferred locale. Defaults to 'US'.

Example: US

createdOn

string

Timestamp when the customer account was created.

Example: 2024-01-15T10:30:00Z

customerId

string

UUID of the customer account.

Example: d3c4e5f6-7890-abcd-ef01-234567890abc

email

string

Customer email address. Omitted from the response if not available.

firstName

string

Customer first name.

Example: John

language

string

Language code derived from the customer's preferred locale. Defaults to 'en'.

Example: en

lastName

string

Customer last name.

Example: Smith

region

string

Always empty.

status

string · enum

Customer account status.

Enum values:

PENDING

ACTIVE

TERMINATED

Example: ACTIVE

timezone

string

Customer timezone. Defaults to 'America/New_York'.

Example: America/New_York

verificationUrl

string

URL the customer must visit to verify their account.

ccTLD Edge Cases Pricing