> For the complete documentation index, see [llms.txt](https://fusionauth.io/docs/llms.txt) # Retrieve Pending Family Members API documentation for the FusionAuth Retrieve Pending Family Members API. # Retrieve Pending Family Members This API is used to retrieve the users pending parent approval. ## Request [!API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#api-key-authentication) Retrieve pending users by parent email address GET/api/user/family/pending?parentEmail={parentEmail} OpenAPI Spec ### Request Parameters `parentEmail`Stringrequired The email address of the parent. #### Request Headers `X-FusionAuth-TenantId`Stringoptional 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](https://fusionauth.io/docs/apis/authentication.md#making-an-api-request-using-a-tenant-id) for additional information. ## Response The response for this API contains the requested pending users. *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](https://fusionauth.io/docs/apis/errors.md) 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](https://fusionauth.io/docs/apis/authentication.md). | | 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 `users[x].active`Boolean True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login. `users[x].birthDate`String The User's birthdate formatted as `YYYY-MM-DD` `users[x].data`Object An object that can hold any information about the User that should be persisted. `users[x].email`String The User's email address. `users[x].fullName`String The User's full name as a separate field that is not calculated from **firstName** and **lastName**. `users[x].id`UUID The User's unique Id. `users[x].insertInstant`Long The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) when the user was created. `users[x].parentEmail`String The user's parent's email address. `users[x].passwordChangeRequired`Boolean Indicates that the User's password needs to be changed during their next login attempt. `users[x].passwordLastUpdateInstant`Long The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the User last changed their password. `users[x].preferredLanguages`Array An array of locale strings that give, in order, the User's preferred languages. These are important for email templates and other localizable text. See [Locales](https://fusionauth.io/docs/reference/data-types.md#locales). `users[x].tenantId`UUID The Id of the Tenant that this User belongs to. `users[x].timezone`String The User's preferred timezone. This can be used as a default to display instants, and it is recommended that you allow User's to change this per-session. The string will be in an [IANA](https://www.iana.org/time-zones) time zone format. `users[x].twoFactor.methods[x].authenticator.algorithm`String The algorithm used by the TOTP authenticator. With the current implementation, this will always be `HmacSHA1`. `users[x].twoFactor.methods[x].authenticator.codeLength`Integer The length of code generated by the TOTP. With the current implementation, this will always be `6`. `users[x].twoFactor.methods[x].authenticator.timeStep`Integer The time-step size in seconds. With the current implementation, this will always be 30. `users[x].twoFactor.methods[x].email`String The value of the email address for this method. Only present if **user.twoFactor.methods`[x]`.method** is `email`. `users[x].twoFactor.methods[x].id`String The unique Id of the method. `users[x].twoFactor.methods[x].lastUsed`Boolean `true` if this method was used most recently. `users[x].twoFactor.methods[x].method`String The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are: * `authenticator` * `email` * `sms` `users[x].twoFactor.methods[x].mobilePhone`String The value of the mobile phone for this method. Only present if **user.twoFactor.methods`[x]`.method** is `sms`. `users[x].twoFactor.recoveryCodes`Array A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated. As of `1.68.0`, this field will always be empty. Recovery codes are hashed at rest and cannot be returned in responses. `users[x].twoFactorDelivery`StringDEPRECATED The User's preferred delivery for verification codes during a two-factor login request. The possible values are: * `None` * `TextMessage` `users[x].twoFactorEnabled`BooleanDEPRECATED Determines if the User has two-factor authentication enabled for their account or not. Removed in 1.26.0 `users[x].username`String The username of the User. `users[x].usernameStatus`String The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are: * `ACTIVE` - the username is active * `PENDING` - the username is pending approval/moderation * `REJECTED` - the username was rejected during moderation If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again. `users[x].verified`Boolean Whether or not the User's email has been verified. *Example Response JSON* ```json { "users": [ { "active": true, "birthDate": "2009-10-31", "data": { "attr1": "value1", "attr2": [ "value2", "value3" ] }, "email": "somekid@piedpiper.com", "fullName": "Kid A", "id": "00000000-0000-0001-0000-000000000003", "insertInstant": 1572551641422, "parentEmail": "somekidsparent@piedpiper.com", "passwordChangeRequired": false, "passwordLastUpdateInstant": 1572551641422, "preferredLanguages": [ "en", "fr" ], "tenantId": "64653766-6162-6234-3036-393935316533", "timezone": "America/Denver", "twoFactorDelivery": "None", "twoFactorEnabled": false, "username": "somekid", "usernameStatus": "ACTIVE", "verified": true } ] } ```