SQsquarespace
Contacts

Get address book

Returns paginated addresses for the contact. When there is at least one entry, exactly one is the default shipping address (defaultShippingAddressId and each entry's defaultShipping reflect this). The default shipping address (when present) is always included on the first page of results. 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/{contactId}/address-book

Request

Path parameters

contactIdstring required

The contact's ID.

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

Paginated list of the contact's addresses. When there is at least one entry, the first page always includes the default shipping address, and defaultShippingAddressId identifies it. On later pages, addressBookEntries is the next slice only; defaultShippingAddressId is present only when the default shipping entry appears in that slice.

Example response

{
  "addressBook": {
    "addressBookEntries": [
      {
        "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"
      }
    ]
  }
}

Changes

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