v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Households

List all households

List all households (Clients and Prospects). Supports filtering by book id, household type, updated_since timestamp, email, and phone.

get/v1/households

Query parameters

book_idstring

Filter by book ID to scope to a specific book

household_type'client' | 'prospect' | 'past_client'

Filter by household type

type'client' | 'prospect' | 'past_client'

Alias for household_type

updated_sincestring

Filter households updated since this ISO8601 timestamp

emailstring

Filter by exact email match after normalization

phonestring

Filter by exact phone match (E.164 format)

namestring

Filter by person name (prefix/full-text match, not arbitrary substring)

pageinteger

Page number

per_pageinteger

Items per page (max 100)

Response

successful

Example response

{
  "data": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}