get the user's family
GET
/user/family
Get the family for the authorised user. This includes the family members and registered devices.
- Stubbed families (initial families that are created for members and devices for data integrity) are not returned by default. They will result in a 200 OK response with a null family object:
{ family: null }
Authorizations
bearerAuth
TypeHTTP (bearer)
Parameters
Query Parameters
showhistory
"true" - include the history for the family in the response
Typestring
Example
allowStub
"true" - returns families that have not been populated yet (have no deivces and no members)
Typestring
Example
Responses
200 OK
application/json
JSON
{
"family": {
"country": "GB",
"createdAt": "2024-01-29T19:33:32.493Z",
"devices": [
{
"addedAt": "2024-01-29T19:33:32.492Z",
"deviceId": "t21KFoWYO48DwzXPIo7ObZ7U"
}
],
"familyId": "65b7fd8c47d7ce1261703591",
"flags": {
"sharingOn": true
},
"members": [
{
"addedAt": "2024-01-29T19:33:32.492Z",
"approved": true,
"approvedAt": "2024-01-29T19:33:32.492Z",
"userId": "65afcb79a4f5ae5550e6e63a",
"verified": true,
"verifiedEmail": "test@test.com"
},
{
"addedAt": "2024-01-29T19:33:32.492Z",
"approved": false,
"userId": "65afcb79a4f5ae5550e6e63a",
"verified": false
}
]
}
}