Profiles

List profiles

GET

https://api.squarespace.com

/1.0/profiles

Retrieves all profiles; profiles can be filtered and sorted. The response contains up to 50 Profiles and supports dynamic cursors for pagination.

List profiles › query Parameters

sortDirection

string

Identifies the sort direction of the result list; asc for ascending or dsc for descending. If not specified, the returned list is in descending order.

sortField

string

Identifies the sort field of the result list. Values include: createdOn, id, email, or lastName. If not specified, the returned list is sorted by id.

filter

string

Semicolon separated list used to filter profile results. Values include: isCustomer and/or hasAccount, or email. The email filter cannot be used with isCustomer or hasAccount.

email

string

Email address filter (URL-encoded, case insensitive).

cursor

string

Identifies where the next page of results should begin. Should be the value of pagination.nextPageCursor from a previous response. Cannot be used with other parameters.

List profiles › 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

List profiles › Responses

A paginated list of profiles.

PaginatedProfileListResponse

object

Profile[]

GET/1.0/profiles

curl https://api.squarespace.com/1.0/profiles \
  --header 'User-Agent: YOUR_CUSTOM_APP_DESCRIPTION' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "pagination": {
    "hasNextPage": true,
    "nextPageCursor": "ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ",
    "nextPageUrl": "/1.0/profiles?cursor=ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ"
  },
  "profiles": [
    {
      "acceptsMarketing": true,
      "address": {
        "address1": "459 Broadway",
        "address2": "address2",
        "city": "New York",
        "countryCode": "US",
        "firstName": "Bob",
        "lastName": "Loblaw",
        "phone": "5553334444",
        "postalCode": "10003",
        "state": "NY"
      },
      "createdOn": "2024-08-25T15:00:00Z",
      "email": "email",
      "firstName": "firstName",
      "hasAccount": true,
      "id": "id",
      "isCustomer": true,
      "lastName": "lastName",
      "transactionsSummary": {
        "donationCount": 0,
        "firstDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "firstOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "lastDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "lastOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "orderCount": 0,
        "totalDonationAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalOrderAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalRefundAmount": {
          "currency": "USD",
          "value": 49.99
        }
      }
    }
  ]
}

json

application/json

Get profiles

GET

https://api.squarespace.com

/1.0/profiles/{profileIdCsvs}

Retrieves information for specific profiles. The response contains a list of up to 50 Profiles. Multiple Profiles can be retrieved by providing a comma-separated list of profile ids.

Get profiles › path Parameters

profileIdCsvs

string · required

Specifies the profiles to retrieve. Multiple Profiles can be retrieved by providing a comma-separated list of profile ids.

Get profiles › 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

Get profiles › Responses

The requested profiles.

ProfileListResponse

Profile[]

GET/1.0/profiles/{profileIdCsvs}

curl https://api.squarespace.com/1.0/profiles/:profileIdCsvs \
  --header 'User-Agent: YOUR_CUSTOM_APP_DESCRIPTION' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "profiles": [
    {
      "acceptsMarketing": true,
      "address": {
        "address1": "459 Broadway",
        "address2": "address2",
        "city": "New York",
        "countryCode": "US",
        "firstName": "Bob",
        "lastName": "Loblaw",
        "phone": "5553334444",
        "postalCode": "10003",
        "state": "NY"
      },
      "createdOn": "2024-08-25T15:00:00Z",
      "email": "email",
      "firstName": "firstName",
      "hasAccount": true,
      "id": "id",
      "isCustomer": true,
      "lastName": "lastName",
      "transactionsSummary": {
        "donationCount": 0,
        "firstDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "firstOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "lastDonationSubmittedOn": "2024-08-25T15:00:00Z",
        "lastOrderSubmittedOn": "2024-08-25T15:00:00Z",
        "orderCount": 0,
        "totalDonationAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalOrderAmount": {
          "currency": "USD",
          "value": 49.99
        },
        "totalRefundAmount": {
          "currency": "USD",
          "value": 49.99
        }
      }
    }
  ]
}

json

application/json

Transactions WebhookSubscriptions