v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Contacts

List contacts

List all contacts. Supports filtering by book_id, email, phone, and name.

get/v1/contacts

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

book_idstring

Filter by book ID

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)

Response

successful

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "book_id": "book123xyz",
      "person": {
        "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"
        }
      },
      "custom_fields": {
        "referral_source": "Conference"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}