Skip to main content

Retrieves the current user's family overview

GET 

/api/v1/families/mine

Returns the family, all members with sharing state, the current user's sharing settings, and active location requests. Requires family membership. A member whose entitlement has lapsed still gets 200, with lapsed: true and a reduced payload carrying only the family name and the user's role — members and location_requests are omitted. A user who is neither entitled nor in a family gets 403.

Request​

Responses​

family overview