Get my profile
get_my_profileLoad the authenticated homeowner profile. Use this only when the HireNimbus account is already connected, to fill the saved service address before search. Do not call this to start discovery for an anonymous user, and do not start phone/OTP just to search or compare pros. If this returns status "auth_required", continue with ZIP + search and show pros; trigger connect/OTP only when create_booking returns auth_required after the homeowner chose a pro.
Returns GetMyProfileResult (structured JSON):
status (string, required): "ok", "error", or "auth_required"
name (string|null): homeowner full name when status is ok
phone (string|null): homeowner phone when status is ok
address (object|null): service street address with address1, address2, city, region, postalCode, country, formattedAddress
search_location (string|null): 5-digit ZIP from address.postalCode for search_providers.location (after user confirms the saved street address is the job site; never City, ST, the street line, formattedAddress, or address1)
error_code (string|null): "AUTH_REQUIRED" when status is auth_required
message (string|null): error or auth_required explanation
If address.postalCode exists: show the saved street address, confirm it is the job site, then pass that postalCode as location. If address.postalCode is missing: ask once "What's the ZIP for the job?" Do not ask for city/state first. Name, street, and phone can wait until preview/book.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| context | No | Always include this argument on every call — do not omit it (analytics / Agent Intent). Write 15-25 words in third person explaining why this tool is being called. Abstract purpose only: never names, phones, emails, street addresses, IDs, or other PII. Example: "Homeowner wants vetted local plumbers for a leaking kitchen faucet within the previously confirmed ZIP." |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Homeowner full name from profile (present when status is ok) | |
| phone | No | Homeowner phone from profile (present when status is ok) | |
| status | Yes | Outcome: "ok" when profile loaded, "auth_required" when unsigned-in, "error" otherwise | |
| address | No | Full service street address on file with fields address1, address2, city, region, postalCode, country, formattedAddress | |
| message | No | Error or auth_required explanation | |
| error_code | No | Stable code such as "AUTH_REQUIRED" when status is auth_required | |
| next_action | No | When status is auth_required: "continue_discovery" means search and show pros without OTP; "connect_to_book" means start phone/OTP connect now | |
| search_location | No | 5-digit US ZIP from address.postalCode (e.g. "22307" or "94114") — pass to search_providers.location after the user confirms the saved street address is the job site. Never City, ST, a street line, formattedAddress, or address1. |