Retrieve a Family

Edit on GitHubEdit MD

This API is used to retrieve a Family by a User Id or by Family Id.

Request#

Retrieve a Family by Id

GET/api/user/family/{familyId}

OpenAPI Spec

Request Parameters#

familyId UUID required

The unique Id of the Family.

Request Headers#

X-FusionAuth-TenantId String optional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request#

Retrieve all of a User's families by User Id

GET/api/user/family?userId={userId}

OpenAPI Spec

Request Parameters#

userId UUID required

The unique Id of the User.

Request Headers#

X-FusionAuth-TenantId String optional

The unique Id of the tenant used to scope this API request.

See Making an API request using a Tenant Id for additional information.

The response for this API contains the requested family or families.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

family.id UUID

The unique Id of the family.

family.insertInstant Long

The instant that the Family was added to the FusionAuth database.

family.lastUpdateInstant Long

The instant that the Family was updated in the FusionAuth database.

family.members Array<Object>

The members of this family.

family.members[x].insertInstant Long

The instant when the user was added to the family.

families.members[x].lastUpdateInstant Long

The instant when the family member was last updated.

family.members[x].owner Boolean

True if this user is the owner of the family, the first Adult user in the family will automatically be set as the owner. A teen or child cannot be the family owner.

family.members[x].role String

The role of the family member.

The possible values are:

Adult
Child
Teen

family.members[x].userId UUID

The unique user Id of the family member.

Example Response JSON

{
  "family": {
    "id": "a815b480-d52d-4755-96ac-749c067925d7",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "members": [
      {
        "insertInstant": 1562010348111,
        "lastUpdateInstant": 1595361143101,
        "owner": true,
        "role": "Adult",
        "userId": "b3360a2d-e81d-4314-b9f1-244a916ca52f"
      }
    ]
  }
}

Response Body#

families Array<Object>

The list of Family objects.

families[x].id UUID

The unique Id of the family.

families[x].insertInstant Long

The instant that the Family was added to the FusionAuth database.

families[x].lastUpdateInstant Long

The instant that the Family was updated in the FusionAuth database.

families[x].members Array<Object>

The members of this family.

families[x].members[x].insertInstant Long

The instant when the user was added to the family.

families[x].members[x].lastUpdateInstant Long

The instant when the family member was last updated.

families[x].members[x].owner Boolean

True if this user is the owner of the family, the first Adult user in the family will automatically be set as the owner. A teen or child cannot be the family owner.

families[x].members[x].role String

The role of the family member. The possible values are:

Adult
Child
Teen

families[x].members[x].userId UUID

The unique user Id of the family member.

Example Response JSON

{
  "families": [
    {
      "id": "a815b480-d52d-4755-96ac-749c067925d7",
      "insertInstant": 1595361142909,
      "lastUpdateInstant": 1595361143101,
      "members": [
        {
          "insertInstant": 1562010348111,
          "lastUpdateInstant": 1595361143101,
          "owner": true,
          "role": "Adult",
          "userId": "b3360a2d-e81d-4314-b9f1-244a916ca52f"
        }
      ]
    }
  ]
}