# Hostreach

> Hostreach public API — real-estate lead extraction, CRM, WhatsApp messaging and scheduling.

## Docs

- [Connect a WhatsApp account](https://docs.hostreach.io/api-reference/accounts/connect-a-whatsapp-account.md)
- [Disconnect a WhatsApp account](https://docs.hostreach.io/api-reference/accounts/disconnect-a-whatsapp-account.md)
- [List WhatsApp accounts](https://docs.hostreach.io/api-reference/accounts/list-whatsapp-accounts.md)
- [Update account settings](https://docs.hostreach.io/api-reference/accounts/update-account-settings.md)
- [Add WhatsApp account to campaign](https://docs.hostreach.io/api-reference/campaigns/add-whatsapp-account-to-campaign.md)
- [Create a campaign](https://docs.hostreach.io/api-reference/campaigns/create-a-campaign.md): Creates a campaign in `draft` status. Use `PATCH /:id/status` to set it to `running`.
- [Delete a campaign](https://docs.hostreach.io/api-reference/campaigns/delete-a-campaign.md)
- [Delete an extraction record from campaign](https://docs.hostreach.io/api-reference/campaigns/delete-an-extraction-record-from-campaign.md)
- [Duplicate a campaign](https://docs.hostreach.io/api-reference/campaigns/duplicate-a-campaign.md)
- [Execute a campaign](https://docs.hostreach.io/api-reference/campaigns/execute-a-campaign.md): Manually triggers an extraction and send cycle. Consumes one execution from the workspace quota.
- [Export campaign leads as CSV](https://docs.hostreach.io/api-reference/campaigns/export-campaign-leads-as-csv.md)
- [Get a campaign](https://docs.hostreach.io/api-reference/campaigns/get-a-campaign.md)
- [Get campaign segmentation](https://docs.hostreach.io/api-reference/campaigns/get-campaign-segmentation.md)
- [Get campaign stats](https://docs.hostreach.io/api-reference/campaigns/get-campaign-stats.md)
- [Get outreach sequence](https://docs.hostreach.io/api-reference/campaigns/get-outreach-sequence.md)
- [List campaign extraction history](https://docs.hostreach.io/api-reference/campaigns/list-campaign-extraction-history.md)
- [List campaign leads](https://docs.hostreach.io/api-reference/campaigns/list-campaign-leads.md)
- [List campaign WhatsApp accounts](https://docs.hostreach.io/api-reference/campaigns/list-campaign-whatsapp-accounts.md)
- [List campaigns](https://docs.hostreach.io/api-reference/campaigns/list-campaigns.md)
- [Remove WhatsApp account from campaign](https://docs.hostreach.io/api-reference/campaigns/remove-whatsapp-account-from-campaign.md)
- [Update a campaign](https://docs.hostreach.io/api-reference/campaigns/update-a-campaign.md)
- [Update campaign segmentation](https://docs.hostreach.io/api-reference/campaigns/update-campaign-segmentation.md)
- [Update campaign status](https://docs.hostreach.io/api-reference/campaigns/update-campaign-status.md): Valid transitions: `draft → running`, `running → paused`, `paused → running`.
- [Update outreach sequence](https://docs.hostreach.io/api-reference/campaigns/update-outreach-sequence.md)
- [Delete an extraction](https://docs.hostreach.io/api-reference/extractions/delete-an-extraction.md): Deletes the extraction record. Leads extracted by this job are preserved.
- [Get extraction status](https://docs.hostreach.io/api-reference/extractions/get-extraction-status.md)
- [List extraction leads](https://docs.hostreach.io/api-reference/extractions/list-extraction-leads.md): Returns the leads generated by this extraction. Available once `status` is `COMPLETED`.
- [List extractions](https://docs.hostreach.io/api-reference/extractions/list-extractions.md)
- [Start a lead extraction](https://docs.hostreach.io/api-reference/extractions/start-a-lead-extraction.md): Starts an asynchronous lead extraction on a real-estate portal. Returns immediately with `extractionId` and `status: QUEUED`.
- [Delete a property sheet](https://docs.hostreach.io/api-reference/fichas/delete-a-property-sheet.md)
- [Generate a property sheet from a listing URL](https://docs.hostreach.io/api-reference/fichas/generate-a-property-sheet-from-a-listing-url.md): Generates a branded property sheet from a listing URL (e.g. from Idealista or Fotocasa). Consumes `maxFichasPerMonth` quota.
- [Get a property sheet](https://docs.hostreach.io/api-reference/fichas/get-a-property-sheet.md)
- [List property sheets](https://docs.hostreach.io/api-reference/fichas/list-property-sheets.md)
- [Update property sheet price](https://docs.hostreach.io/api-reference/fichas/update-property-sheet-price.md)
- [Get current workspace and API key identity](https://docs.hostreach.io/api-reference/identity/get-current-workspace-and-api-key-identity.md)
- [Get quota usage for the current billing period](https://docs.hostreach.io/api-reference/identity/get-quota-usage-for-the-current-billing-period.md)
- [Create a lead note](https://docs.hostreach.io/api-reference/leads/create-a-lead-note.md)
- [Delete a lead](https://docs.hostreach.io/api-reference/leads/delete-a-lead.md)
- [Delete a lead note](https://docs.hostreach.io/api-reference/leads/delete-a-lead-note.md)
- [Export leads as CSV](https://docs.hostreach.io/api-reference/leads/export-leads-as-csv.md)
- [Get a lead](https://docs.hostreach.io/api-reference/leads/get-a-lead.md)
- [Get leads by status (kanban view)](https://docs.hostreach.io/api-reference/leads/get-leads-by-status-kanban-view.md)
- [List lead notes](https://docs.hostreach.io/api-reference/leads/list-lead-notes.md)
- [List leads](https://docs.hostreach.io/api-reference/leads/list-leads.md)
- [Update a lead note](https://docs.hostreach.io/api-reference/leads/update-a-lead-note.md)
- [Update lead contact name](https://docs.hostreach.io/api-reference/leads/update-lead-contact-name.md)
- [Update lead status](https://docs.hostreach.io/api-reference/leads/update-lead-status.md)
- [Get lead conversation history](https://docs.hostreach.io/api-reference/messaging/get-lead-conversation-history.md)
- [Get scheduled follow-ups for a lead](https://docs.hostreach.io/api-reference/messaging/get-scheduled-follow-ups-for-a-lead.md)
- [List conversations](https://docs.hostreach.io/api-reference/messaging/list-conversations.md)
- [Mark lead conversations as read](https://docs.hostreach.io/api-reference/messaging/mark-lead-conversations-as-read.md)
- [Send a template message to a lead](https://docs.hostreach.io/api-reference/messaging/send-a-template-message-to-a-lead.md)
- [Send a WhatsApp message to a lead](https://docs.hostreach.io/api-reference/messaging/send-a-whatsapp-message-to-a-lead.md)
- [Get publicv1platforms](https://docs.hostreach.io/api-reference/platforms/get-publicv1platforms.md)
- [Get publicv1platforms filters](https://docs.hostreach.io/api-reference/platforms/get-publicv1platforms-filters.md)
- [Get publicv1platforms locations](https://docs.hostreach.io/api-reference/platforms/get-publicv1platforms-locations.md)
- [Post publicv1platforms validate](https://docs.hostreach.io/api-reference/platforms/post-publicv1platforms-validate.md)
- [Cancel an appointment](https://docs.hostreach.io/api-reference/scheduling/cancel-an-appointment.md)
- [Create an event type](https://docs.hostreach.io/api-reference/scheduling/create-an-event-type.md)
- [Delete an event type](https://docs.hostreach.io/api-reference/scheduling/delete-an-event-type.md)
- [Duplicate an event type](https://docs.hostreach.io/api-reference/scheduling/duplicate-an-event-type.md)
- [Get an event type](https://docs.hostreach.io/api-reference/scheduling/get-an-event-type.md)
- [Get availability slots](https://docs.hostreach.io/api-reference/scheduling/get-availability-slots.md)
- [List appointments](https://docs.hostreach.io/api-reference/scheduling/list-appointments.md)
- [List event types](https://docs.hostreach.io/api-reference/scheduling/list-event-types.md)
- [Update an event type](https://docs.hostreach.io/api-reference/scheduling/update-an-event-type.md)
- [Create a message template](https://docs.hostreach.io/api-reference/templates/create-a-message-template.md)
- [Delete a message template](https://docs.hostreach.io/api-reference/templates/delete-a-message-template.md)
- [List message templates](https://docs.hostreach.io/api-reference/templates/list-message-templates.md)
- [Update a message template](https://docs.hostreach.io/api-reference/templates/update-a-message-template.md)
- [Create a property valuation](https://docs.hostreach.io/api-reference/valuations/create-a-property-valuation.md): Creates a valuation that searches comparable properties in the area and generates a price estimate. Consumes `maxValuationsPerMonth` quota.
- [Delete a valuation](https://docs.hostreach.io/api-reference/valuations/delete-a-valuation.md)
- [Get a valuation](https://docs.hostreach.io/api-reference/valuations/get-a-valuation.md)
- [Get valuation comparables](https://docs.hostreach.io/api-reference/valuations/get-valuation-comparables.md)
- [List valuations](https://docs.hostreach.io/api-reference/valuations/list-valuations.md)
- [Rename a valuation](https://docs.hostreach.io/api-reference/valuations/rename-a-valuation.md)
- [Update valuation prices](https://docs.hostreach.io/api-reference/valuations/update-valuation-prices.md)
- [Update valuation report config](https://docs.hostreach.io/api-reference/valuations/update-valuation-report-config.md)
- [Create a webhook subscription](https://docs.hostreach.io/api-reference/webhooks/create-a-webhook-subscription.md)
- [Delete a webhook subscription](https://docs.hostreach.io/api-reference/webhooks/delete-a-webhook-subscription.md)
- [List webhook subscriptions](https://docs.hostreach.io/api-reference/webhooks/list-webhook-subscriptions.md)
- [Test a webhook endpoint](https://docs.hostreach.io/api-reference/webhooks/test-a-webhook-endpoint.md)
- [Update a webhook subscription](https://docs.hostreach.io/api-reference/webhooks/update-a-webhook-subscription.md)
- [Authentication](https://docs.hostreach.io/authentication.md): How to authenticate with the Hostreach API using API keys.
- [Agent Skill](https://docs.hostreach.io/integrations/agent-skill.md): Teach AI coding agents best practices for using the Hostreach API.
- [CLI](https://docs.hostreach.io/integrations/cli.md): Call any Hostreach API endpoint from your terminal. Auto-generated from the OpenAPI spec.
- [MCP Server](https://docs.hostreach.io/integrations/mcp.md): Use Hostreach inside Cursor, Claude Desktop, and Codex via the Model Context Protocol.
- [Integrations Overview](https://docs.hostreach.io/integrations/overview.md): Use Hostreach from AI agents, the terminal, or workflow tools.
- [Introduction](https://docs.hostreach.io/introduction.md): Automate real-estate lead generation, CRM, and WhatsApp outreach with the Hostreach API.
- [Quickstart](https://docs.hostreach.io/quickstart.md): Make your first Hostreach API call in under 5 minutes.

## OpenAPI Specs

- [openapi](https://docs.hostreach.io/openapi.json)