Start a home search
start_home_searchRead-onlyIdempotent
Check that a city is supported and return the Socials Homes signup link for it, with what happens next. It does not create an account, save anything or send any message: the person opens the link and sets up their own search there.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | The city, as a slug from list_cities ("the_hague") or a name ("The Hague"). | |
| move_in | No | Optional move-in date, YYYY-MM-DD. | |
| budget_max_eur | No | Maximum monthly rent in EUR, a whole number from 50 to 20000. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | ||
| supply | Yes | ||
| move_in | Yes | ||
| next_steps | Yes | ||
| signup_url | Yes | ||
| budget_max_eur | Yes | ||
| writes_nothing | Yes |