SQsquarespace
Contacts

List contacts

Returns a paginated list of contacts for the website. Requires OAuth website scope website.contacts.read or website.contacts, or API key scope CONTACT_READONLY or CONTACT, or OAuth website scope website.profiles.read or website.profiles (OAuth only).

get/v1/contacts

Request

Query parameters

pageSizeinteger

number of contacts to retrieve per request

cursorstring

where next page of results begins. should be {pagination.nextPageCursor} from previous response.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

A paginated list of contacts.

Example response

{
  "contacts": [
    {
      "defaultShippingAddress": {
        "address": {
          "city": "Springfield",
          "countryCode": "US",
          "firstName": "John",
          "lastName": "Doe",
          "line1": "100 Main St",
          "line2": "Apt 1A",
          "phoneNumber": "215-555-4321",
          "postalCode": "10900",
          "region": "IL"
        },
        "id": "5f8d0d55b54764421b7156aa"
      },
      "id": "64a7e3d2c8f1b95e30a14d2b",
      "locale": "en-US",
      "primaryEmail": {
        "email": "jane.doe@example.com"
      }
    }
  ],
  "pagination": {
    "hasNextPage": true,
    "nextPageCursor": "ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ",
    "nextPageUrl": "/v1/contacts?cursor=ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.