v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Households

Get a household

Retrieve a household (Client or Prospect) by ID

get/v1/households/{id}

Response

successful

idstring required

The ID of the household

type'Client' | 'Prospect' required

The type of household

namestring required

The name of the household

tierstring nullable

The tier label for this household (null for Prospects)

became_client_atstring date-time nullable

When this household became a client (null for Prospects)

book_idstring required

The ID of the book this household belongs to

profile_picture_urlstring uri nullable

URL to the household profile picture

custom_fieldsobject

Custom field values as key-value pairs

Example response

{
  "id": "abc123xyz",
  "type": "Client",
  "name": "The Smith Family",
  "tier": "Platinum",
  "became_client_at": "2024-01-01T00:00:00Z",
  "book_id": "book123xyz",
  "profile_picture_url": "https://api.example.com/v1/households/abc123xyz/avatar",
  "custom_fields": {
    "pageport_lead_source": "Landing Page",
    "industry": "Technology"
  },
  "people": [
    {
      "id": "abc123xyz",
      "book_id": "book123xyz",
      "household_id": "xyz789abc",
      "contact_id": "cnt456def",
      "role_type": "client",
      "first_name": "John",
      "middle_name": "Robert",
      "last_name": "Doe",
      "salutation": "Mr.",
      "suffix": "Jr.",
      "maiden_name": "Smith",
      "gender": "male",
      "designations": "CPA, CFP",
      "household_role": "head_of_household",
      "preferred_name": "Johnny",
      "date_of_birth": "1985-06-15",
      "job_title": "Software Engineer",
      "ssn": "***-**-6789",
      "drivers_license_number": "******7890",
      "email_addresses": [
        {
          "email": "john.doe@example.com",
          "email_type": "personal",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+15555551234",
          "extension": "1234",
          "phone_type": "mobile",
          "is_primary": true
        }
      ],
      "addresses": [
        {
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country_code": "US",
          "address_type": "home",
          "is_primary": true
        }
      ],
      "employments": [
        {
          "id": "emp123xyz",
          "person_id": "abc123xyz",
          "business_name": "Acme Corp",
          "role": "Software Engineer",
          "start_date": "2023-01-15",
          "end_date": "2024-12-31",
          "actively_employed": true
        }
      ],
      "custom_fields": {
        "preferred_contact_method": "Email",
        "risk_tolerance": "Moderate"
      }
    }
  ]
}