Overview
The Families API enables multi-caregiver collaboration. Families group users together with role-based permissions to share access to baby profiles and activities.Family Schema
Create Family
Create a new family. The authenticated user automatically becomes the owner.Parameters
Family name (e.g., “Smith Family”, “Grandparents”)
Response
The newly created family ID
The creating user is automatically added as a family member with the “owner” role and cannot be removed.
List My Families
Retrieve all families the authenticated user belongs to.Response
Array of family objects with the user’s role included
Get Family
Retrieve details for a specific family.Parameters
The family ID
Response
Returns the family object with the user’s role, ornull if not a member.
List Family Members
Retrieve all members of a family.Parameters
The family ID
Response
Array of family member objects with enriched user data
Invite Caregiver
Invite a new member to the family by email.Parameters
The family ID
Email address of the person to invite
Role to assign (“admin” or “caregiver”). Defaults to “caregiver”
Response
The created invitation ID
Invitations expire after 7 days. The invitee must accept before expiration.
List Invitations
Retrieve pending invitations for a family.Parameters
The family ID
Response
Accept Invitation
Accept a pending invitation (called by the invitee).Parameters
The invitation ID
The authenticated user’s email must match the invitation email. The invitation is automatically marked as accepted and the user is added to the family.
Decline Invitation
Decline a pending invitation.Parameters
The invitation ID
Remove Member
Remove a member from the family.Parameters
The family ID
User ID of the member to remove
Role Permissions
- Owner
- Admin
- Caregiver
Full Control
- Create and delete baby profiles
- Invite and remove any member
- Change member roles
- Delete the family
- All caregiver and admin permissions
Every family has exactly one owner who cannot be removed.
Best Practices
Use descriptive family names
Use descriptive family names
Choose clear names like “Grandparents” or “Daycare Staff” to help members identify their role and context.
Assign appropriate roles
Assign appropriate roles
- Owner: Primary parent/guardian
- Admin: Co-parent or primary caregiver
- Caregiver: Babysitters, grandparents, daycare staff
Monitor pending invitations
Monitor pending invitations
Invitations expire after 7 days. Follow up with invitees to ensure they accept in time.
Review members periodically
Review members periodically
Remove members who no longer need access to maintain security and data privacy.
Related Resources
Caregivers
Learn about caregiver profiles and attribution
Roles
Detailed role permissions guide
Baby Profiles
Manage baby profiles within families
Authentication
API authentication guide
