get_user_multiprofile_info
Fetch the authenticated user's profile, apartments, family members, society details, and pass codes from NoBrokerHood. Use to obtain apartment IDs and user data.
Instructions
Fetch the authenticated user's multiprofile information.
Use this when the user asks about their profile, apartments, family members, society details, or pass codes: "what apartments do I have?", "show my profile", "who are my family members?", "what's my pass code?", "which societies am I in?".
Also use this FIRST whenever another tool needs an apartment_id — unless the user explicitly provided the apartment_id, in which case use it directly. Call with fields=["data.apartments.apartment.id", "data.apartments.apartment.name", "data.apartments.apartment.displayName", "data.apartments.apartment.buildingName"] to identify the right apartment before proceeding. If exactly one apartment is returned, use its ID immediately without asking the user to confirm. If multiple apartments are returned, match the user's input against all of: name (full apartment name), displayName (short label), and buildingName (tower/block name) — the user may refer to any of these.
Args: fields: Dot-notation paths to include in the response. Always specify fields to avoid fetching the full profile (which includes family, notification settings, and other data rarely needed). Omit only if the user explicitly asks for their complete profile information. Examples: - ["data.apartments.apartment.id", "data.apartments.apartment.name", "data.apartments.apartment.displayName", "data.apartments.apartment.buildingName"] → compact apartment list for matching and obtaining an apartment_id - ["data.user.person.name", "data.user.person.phone"] → just the primary user's contact info - ["data.passCodes"] → just the pass codes map
Returns the raw API response dict containing:
user: primary user details (name, email, phone, photo)
family: list of family members registered under the account
apartments: all apartments the user has access to, each with apartment details, area/block info, society info, ownership type (OWNER/TENANT), and residency tag
passCodes: map of apartmentId → entry pass code
notifcationSettings: all notification toggle states
hasMultipleProfile: whether the user has profiles across multiple apartments
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No |