SQsquarespace
Contacts

Get address book entry

Returns a single address book entry for the contact. 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/{addressBookEntryId}

Request

Path parameters

contactIdstring required

The contact's ID.

addressBookEntryIdstring required

The address book entry's ID.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

The requested address book entry.

Example response

{
  "addressBookEntry": {
    "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.