🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/families.md.
Family API
Available since 1.7.0
A Family allows you to define relationships between one or more Users. A adult User may belong to a single Family, a teen or child may belong to one or more families.
The following APIs are provided to manage Families and Family memberships.
| Operation | Method | Endpoint |
|---|---|---|
| Add a User to a Family | POST | /api/user/family/api/user/family/{familyId} |
| Retrieve a Family | GET | /api/user/family/{familyId}/api/user/family?userId={userId} |
| Update a Family | PUT | /api/user/family/{familyId} |
| Remove a User from a Family | DELETE | /api/user/family/{familyId}/{userId} |
| Retrieve Pending Family Members | GET | /api/user/family/pending?parentEmail={parentEmail} |
| Request Parental Approval | POST | /api/user/family/request |