Families

Family records

📄️ Get uploaded photo for a family (binary image)

Get uploaded photo for a family (binary image)

📄️ Upload a family photo from base64 data (EditRecords role required)

Upload a family photo from base64 data (EditRecords role required)

📄️ Delete a family's uploaded photo (EditRecords role required)

Delete a family's uploaded photo (EditRecords role required)

📄️ Get avatar info JSON for a family (for client-side rendering)

Get avatar info JSON for a family (for client-side rendering)

📄️ Get previous and next family IDs for navigation

Get previous and next family IDs for navigation

📄️ Get a family object by ID

Get a family object by ID

📄️ Delete a family record and optionally its members (DeleteRecord role required)

Delete a family record and optionally its members (DeleteRecord role required)

📄️ Get geolocation and driving distance from church for a family

Get geolocation and driving distance from church for a family

📄️ Send a verification email to the family

Send a verification email to the family

📄️ Generate a new family self-verify URL token

Generate a new family self-verify URL token

📄️ Mark a family as verified immediately

Mark a family as verified immediately

📄️ Activate or deactivate a family

Pass status=true to activate or status=false to deactivate the family.

📄️ Approve a self-registered family, clearing its needs-review flag and its members' flags

Approve a self-registered family, clearing its needs-review flag and its members' flags

📄️ Refresh geocoding (latitude/longitude) for a family's address

Refresh geocoding (latitude/longitude) for a family's address

📄️ Move all donations from this family to another (Finance role required)

Move all donations from this family to another (Finance role required)

📄️ Get families whose all members are in the session cart

Get families whose all members are in the session cart

📄️ Get families with no email address on record

Get families with no email address on record

📄️ Search families by name, or by envelope number for finance users (max 15 results)

Search families by name, or by envelope number for finance users (max 15 results)

📄️ Get self-registered families still awaiting review

Get self-registered families still awaiting review

📄️ Get the last 100 families with self-verification notes

Get the last 100 families with self-verification notes

📄️ Get families with pending (unused, non-expired) self-verify tokens

Get families with pending (unused, non-expired) self-verify tokens

📄️ Find a family by check scan string

Find a family by check scan string

📄️ Preview which families would receive a verification email

Returns recipient count, recipient list, families without email, and a template preview. Used by the send-confirmation modal on the People Verify dashboard.

📄️ Get families with wedding anniversaries within 7 days of today

Get families with wedding anniversaries within 7 days of today

📄️ Get the 10 most recently added families

Get the 10 most recently added families

📄️ Get the 10 most recently updated families

Get the 10 most recently updated families

📄️ List user-type notes for a family

Returns all notes of type 'note' for the family, filtered by visibility for the current user. Requires Notes=1 or Admin. Private notes authored by others are excluded for Notes=1 users; admins see all including private.

📄️ Create a note for a family

Creates a note on a family record. Requires Notes=1 or Admin. Cross-family writes are intentional (e.g. visitation teams adding notes on families they visit). See canWriteNoteOnFamily().