listing

Account stage — register a new beycome user (POST /auth/register). Use when the owner has no account yet. beycome is passwordless: registering automatically emails the user a 6-digit sign-in code, so the next step is `beycome_signin_verify` with that code — do NOT call `beycome_signin_start` after signup, the code is already on its way. If the email is already registered, this still just sends a sign-in code (signup doubles as signin-start). Requires ``firstname`` and ``phone``; validation errors come back as HTTP 400 with an ``errors`` array. No prop_id needed.

{
  "type": "object",
  "properties": {
    "email": {
      "description": "User email address.",
      "type": "string"
    },
    "firstname": {
      "description": "User first name.",
      "type": "string"
    },
    "phone": {
      "description": "User phone number.",
      "type": "string"
    },
    "lastname": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "User last name."
    },
    "company_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Company name."
    },
    "is_owner": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "1 if the user is a landlord/owner, 0 otherwise."
    },
    "sms_unsubscribe": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "SMS opt-in flag: 0 = opt-in, 1 = opt-out."
    }
  },
  "required": [
    "email",
    "firstname",
    "phone"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Account stage — send a one-time sign-in code (POST /auth/check-email). beycome is passwordless — never ask the user for a password. This emails the user a 6-digit code (a second, different code also goes out by SMS; either one works). Ask the user for the code they received, then exchange it for the access_token with `beycome_signin_verify`. Read the response body, not the HTTP status — the envelope's ``ok`` mirrors the HTTP status, and auth failures here still return 2xx. Always check ``data.success``: - ``success: true`` (201, "Email sent") — code sent; ask the user for it. - ``success: false`` with "Email not found." (HTTP 200, ``ok: true``) — no account for this email; run `beycome_signup` instead (signup also sends a code). - HTTP 422 (``ok: false``) — the email matched a secondary address; the body still matters: it hints the masked primary login email to use instead. Codes stay valid for 30 minutes. Re-running this tool sends a fresh code and invalidates the old one. Rate-limited (5/min and 100/day per email) — never call it in a loop or as an automatic retry.

{
  "type": "object",
  "properties": {
    "email": {
      "description": "User email address.",
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Account stage — exchange the one-time code for the access_token (POST /auth/validate-code). The gateway to the listing flow. Call after `beycome_signin_start` or `beycome_signup` (both send the code) with the 6-digit code the user received. On success the Bearer token is at ``data.data.access_token`` (``expires_in`` gives its lifetime in seconds — tokens are long-lived, so mid-session expiry is rare). Pass it as ``access_token`` to every authenticated tool: `beycome_submit_property_link`, `beycome_get_my_listings`, `beycome_questionnaire_link`, `beycome_offers`, `beycome_showings`, `beycome_messages`, and `beycome_reply_message`. IMPORTANT — persist the token: save the access_token to your long-term memory/context (and tell the user you have done so). Save it together with the account ``email``, which disambiguates multi-account users and lets you match the right token to the right person. In future sessions, scheduled tasks, and crons, reuse the saved token instead of asking the user to sign in again — that is what makes autonomous workflows (e.g. "check my messages every morning") possible. Before signing a user in, check your memory for an existing token for that email and try it first; only restart the sign-in flow on a 401. The next step depends on where the user is: - No listing yet → `beycome_submit_property_link` to create one. - Has a listing already (or unsure) → `beycome_get_my_listings` to find it; if it is paid but the MLS questionnaire is not submitted, follow with `beycome_questionnaire_link`. - Listing already live → skip straight to the post-publish tools (`beycome_messages`, `beycome_showings`, `beycome_offers`). A wrong or expired code returns HTTP 200 with ``success: false`` and "Invalid code." — check ``data.success``, not the envelope's ``ok``. Codes expire after 30 minutes; if expired, request a fresh one with `beycome_signin_start` (don't retry blindly — sends are rate-limited).

{
  "type": "object",
  "properties": {
    "email": {
      "description": "User email address.",
      "type": "string"
    },
    "code": {
      "description": "6-digit one-time code the user received by email or SMS.",
      "type": "string"
    }
  },
  "required": [
    "email",
    "code"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Discovery stage — is this state served by beycome MLS? (GET /mls/is-covered). No account or prop_id needed. Use before listing to confirm beycome operates in the property's state; ``is_active: true`` means covered. If not covered, the listing flow does not apply.

{
  "type": "object",
  "properties": {
    "state": {
      "description": "State short code (e.g. FL) or full name (e.g. Florida).",
      "type": "string"
    }
  },
  "required": [
    "state"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Discovery stage — estimate a property's SALE value (beycome CMA + Zillow Zestimate). No account or prop_id needed. Returns both estimates plus suggested pricing strategies (fast / balanced / max). Use during discovery to set a list price; pair with `beycome_comps`. For rental inquiries, use `beycome_rental_estimate` instead.

{
  "type": "object",
  "properties": {
    "address": {
      "description": "Full property address in the form 'Street, City, ST ZIP' (e.g. '6104 Timberly Rd S, Mobile, AL 36609'). ZIP is required for reliable results. Include any unit inside the address with a spelled-out designator, e.g. 'Apt 107' or 'Unit 107' — never '#107'.",
      "minLength": 5,
      "type": "string"
    },
    "unit": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional unit number (for example 101). Prefer embedding the unit in the address string as 'Apt 101' instead of using this field."
    }
  },
  "required": [
    "address"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Discovery stage — estimate a property's monthly RENT (POST /gemini-estimate). No account or prop_id needed. Pairs with `beycome_estimate`, but this tool is SPECIFICALLY for rental estimates: use it ONLY for rental inquiries or for properties that have a unit number. For sale-price estimates, use `beycome_estimate`. Returns ``rentEstimate`` (e.g. "$2,600"), ``rentEstimateRange`` (e.g. "$2,400 - $2,800"), and the ``sources`` the figure was grounded on (source URLs are stripped to keep the response small). Caveat: an unrecognized address still returns ``success: true`` with a generic market-average rent — check that the source titles actually reference the property's address/city before trusting the number; if they don't, treat the result as unavailable and ask the user to verify the address.

{
  "type": "object",
  "properties": {
    "address": {
      "description": "Full property address in the form 'Street, City, ST ZIP' (e.g. '501 SW 1st St, Miami, FL 33130'). ZIP is required for reliable results.",
      "minLength": 5,
      "type": "string"
    },
    "unit": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional unit number (for example 304)."
    }
  },
  "required": [
    "address"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Discovery stage — sold comparable listings near a location (GET /comps). No account or prop_id needed. Supports price / beds / baths / area / lot / type filters. Use during discovery to support pricing alongside `beycome_estimate`. Slow endpoint: a cold query can take up to ~1 minute to respond — this is normal, you can always retry the call if it times out. Photo URL and listing-link fields are stripped from the records to keep the response small.

{
  "type": "object",
  "properties": {
    "location": {
      "description": "Location string (city, state, ZIP, etc.).",
      "type": "string"
    },
    "price_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Minimum price."
    },
    "price_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Maximum price."
    },
    "beds_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Minimum beds."
    },
    "beds_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Maximum beds."
    },
    "baths_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Minimum baths."
    },
    "baths_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Maximum baths."
    },
    "living_area_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Minimum living area sqft."
    },
    "living_area_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Maximum living area sqft."
    },
    "lot_size_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Minimum lot size sqft."
    },
    "lot_size_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Maximum lot size sqft."
    },
    "property_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Comma-separated types (singlefamily, condo, townhouse, multifamily, manufactured, land, apartment)."
    },
    "pages": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of result pages to fetch."
    }
  },
  "required": [
    "location"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Questionnaire stage — mint a pre-authorized link to the MLS questionnaire form (POST /api/mls/questionnaire-link). Requires a PAID listing (premium active, Flat/Yes) — whether the user just paid on the submit-property page (`beycome_submit_property_link`) or already had a paid listing with the questionnaire still pending. Returns a pre-authorized link (expires in 7 days) — this tool only hands back the URL; everything else happens in the browser, with no login step. Present the URL and tell the user that on the page they will: 1. review the pre-filled MLS questionnaire and complete any fields Beycome couldn't pre-fill, 2. upload property photos and the required documents, 3. review and submit. After they submit, the listing goes live within about 48 hours, provided all the paperwork clears. Failure modes to relay plainly: 403 — the token is not the owner's; 422 — the listing is not paid yet, or the questionnaire was already submitted; 401 — bad/missing token.

{
  "type": "object",
  "properties": {
    "prop_id": {
      "description": "Property id in beycome.",
      "type": "integer"
    },
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    }
  },
  "required": [
    "prop_id",
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Listing-creation stage — mint a pre-authorized link to the submit-property page (POST /api/mls/submit-property-link). Call AFTER signing in (`beycome_signin_verify`). User-scoped — no prop_id exists yet. Returns a pre-authorized link (expires in 7 days) — this tool only hands back the URL; the listing is created in the browser, with no login step. Present the URL and tell the user that on the page they will: 1. fill out their property's information, 2. set a price, 3. choose a package and any add-ons, 4. pay. Tell them to return to the chat once payment is complete. Prefill: the page accepts prefill params baked into the signed URL. - list_address: the full property address. By this stage the user has already told Claude their address (discovery ran on it), so ALWAYS pass list_address so the page opens pre-filled. - package: the page PRESET INDEX (1-4), not a payment reference — 1 = Basic $99 2 = Enhanced $399 3 = Concierge $999 4 = Basic + Title $199 WARNING: this is the page preset index, NOT an internal payPremiumOpt reference number. Passing a payPremiumOpt reference here is wrong. Only pass package if the user has clearly chosen a tier in chat; otherwise omit it and let them pick on the page. Failure modes to relay plainly: 401 — bad/unverified token. This page is THE way to create a listing — the property is created, priced, and paid for there; there is no in-chat alternative. After the user returns, call `beycome_get_my_listings` to recover the new prop_id, then `beycome_questionnaire_link`.

{
  "type": "object",
  "properties": {
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    },
    "list_address": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Full property address to prefill the page (the address discussed in chat)."
    },
    "package": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Page preset index 1-4: 1=Basic $99, 2=Enhanced $399, 3=Concierge $999, 4=Basic+Title $199. NOT a payPremiumOpt reference."
    }
  },
  "required": [
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Recovery stage — the signed-in user's properties (GET /properties). Token-scoped RESO list endpoint on the normal api base. Two main uses: - After the user finishes the submit-property page (`beycome_submit_property_link`): find the newly created listing (typically the newest entry), CONFIRM the address with the user, then use its id as ``prop_id`` for `beycome_questionnaire_link`. - As the entry point for a returning user who already has listings (or references "my listing" without an id): locate the listing and read its status to pick the next step — paid but questionnaire pending → `beycome_questionnaire_link`; already live → the post-publish tools (`beycome_messages`, `beycome_showings`, `beycome_offers`).

{
  "type": "object",
  "properties": {
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    }
  },
  "required": [
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Post-publish stage — offers received on the owner's listings (GET /offers). Used once a listing is live. Requires ``access_token``. Returns a paginated list (20 per page; pass ``page`` to advance) of every offer across all of the signed-in user's listings — each entry is the full offer record (buyer, price, contingencies, dates, status). Read-only. There is no server-side ``prop_id`` filter; to show offers for one listing, filter client-side on each offer's ``prop_id``. Responding to an offer (accept / reject / counter) is not exposed here.

{
  "type": "object",
  "properties": {
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    },
    "page": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Page number of the paginated offers list (defaults to page 1)."
    }
  },
  "required": [
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Post-publish stage — calendar of showings, open houses, and offer deadlines (GET /calendar/events). Used once a listing is live. The API requires the date range, so it defaults to today → +90 days when omitted (``from_date`` / ``to_date`` are ``YYYY-MM-DD``, with ``to_date`` on or after ``from_date``). ``prop_id`` filters to one listing; omit it for every listing the user owns. The response always mixes ALL event kinds — each event carries a ``type`` field (``showing`` / ``open_house`` / ``offer``). There is no server-side type filter; when the user asks for one kind, filter on that field yourself.

{
  "type": "object",
  "properties": {
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    },
    "prop_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional — filter events to one property id; omit for all listings."
    },
    "from_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Start of the calendar range (YYYY-MM-DD). Defaults to today."
    },
    "to_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "End of the calendar range (YYYY-MM-DD). Defaults to 90 days from today."
    }
  },
  "required": [
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Post-publish stage — read the owner's buyer/inquiry messages (GET /messages). Read-only. Requires ``access_token``. Two modes: - Omit ``thread`` → lists the ~20 most recent conversations, newest first, one row per thread (the latest message in each). Useful fields per row: ``address``, ``prop_id``, ``prop_status``, ``msg`` (latest text), ``subject``, ``requested_by`` / ``email`` (the other party), ``thread``, ``read_msg`` ("0" = unread), ``attachments``, and ``message_type`` (``sender`` if the owner wrote the latest message, else ``receiver``). - Pass ``thread`` → returns that one conversation in full, oldest-first. Use the ``thread`` value from a list row to drill in. The list is not paginated here on purpose (the upstream ``page`` param is overloaded — it sets both page size and page number — so it is not exposed). Soft-deleted messages are dropped after paging, so a page may hold fewer than 20 rows; that is not an error. The payload is a bare array under ``data``. A 401 means the token is no longer valid (logged out, or very old) — re-authenticate with `beycome_signin_start` then `beycome_signin_verify`. To answer a message, use `beycome_reply_message`.

{
  "type": "object",
  "properties": {
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    },
    "thread": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Thread id to open one full conversation (the ``thread`` value from a list row). Omit to list the user's recent conversations."
    }
  },
  "required": [
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

Post-publish stage — reply to a buyer/inquiry message (POST /messages/reply). Sends a real message and queues a real email notification to the recipient, so the text you send is final — treat this as a live send, not a draft. ALWAYS improve the user's drafted reply before sending: fix grammar, spelling, punctuation, capitalization, and formatting, and tighten wording for a clear, professional tone — while preserving their meaning and intent. Send the corrected version, never the raw draft. When the user says "reply saying X", treat X as a rough draft to polish, not literal text to send verbatim. Requires ``to_user_id`` (the counterparty), ``message``, and ``access_token``. For a threaded reply pass the original ``thread`` verbatim and omit ``subject`` (the server prefixes "Re: <original subject>"). To find ``to_user_id``, open the conversation with `beycome_messages` and take the participant id that is not the signed-in owner. Success is 201 with ``data.id`` set to the new message id. Failures come back as 400 with a plain message: "User not found." (bad ``to_user_id``), "You cannot send a message to yourself." (``to_user_id`` is the sender), or "Invalid parameters" (e.g. empty/over-long ``message``). A 401 means the token is no longer valid — re-authenticate with `beycome_signin_start` then `beycome_signin_verify`.

{
  "type": "object",
  "properties": {
    "to_user_id": {
      "description": "Recipient's beycome user id — the counterparty in the thread (the ``fromuser``/``touser`` from a `beycome_messages` row that is NOT the signed-in owner). Cannot be the sender's own id.",
      "minimum": 1,
      "type": "integer"
    },
    "message": {
      "description": "The reply text to send (max 5000 chars).",
      "maxLength": 5000,
      "type": "string"
    },
    "access_token": {
      "description": "Bearer access token from beycome_signin_verify, or a previously saved token from your memory for this user.",
      "type": "string"
    },
    "subject": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional subject (max 255). Omit on a thread reply — the server derives \"Re: <original subject>\"."
    },
    "thread": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Thread id from the original conversation (a `beycome_messages` row's ``thread``). Pass it verbatim to keep the reply stitched to the thread."
    }
  },
  "required": [
    "to_user_id",
    "message",
    "access_token"
  ]
}

{
  "type": "object",
  "additionalProperties": true
}