canonical: https://jentic.com/apis/livabl.com/livabl

# Livabl API

Jentic publishes the only available OpenAPI specification for Livabl API, keeping it validated and agent-ready. Livabl is a new-construction real estate platform, and its Leads API exposes the company's lead pipeline so Featured and Verified Builder clients can sync leads into a CRM, marketing automation tool, or Zapier workflow. The API covers community-level and development-level lead retrieval, individual lead detail, appointment-type leads, Livabl Pro agent leads, company details, and an API key validation endpoint. Each Builder Dashboard account can issue up to 20 API keys scoped per company or per community.

## For AI agents

Pull builder leads (community-level, development-level, appointment-type, and Livabl Pro) from the Livabl Leads API for CRM and marketing automation sync.

## Scope

Does not handle listing inventory, pricing, or floor-plan data - use for Livabl Builder lead retrieval and validation only.

## Capabilities

- Validate an API key against a Livabl Builder account via GET `/Company/ValidateKey`
- Retrieve the full lead list for a company via GET `/Company/Communities/Leads`
- Retrieve leads for a specific development via GET `/Company/Communities/{DevelopmentID}/Leads`
- Get the detail record for a single lead via GET `/Company/Communities/Leads/{LeadID}`
- Pull appointment-type leads via GET `/Company/Communities/AppointmentsLeads/{AppointmentID}`
- List communities and company details via GET `/Company/Communities` and GET `/Company/Details`
- Pull Livabl Pro agent leads via GET `/LivablPro/Leads`

## Use cases

### CRM Lead Sync for Builders

Sync incoming Livabl leads into a Builder's CRM (Salesforce, HubSpot, Follow Up Boss) so sales reps see new prospects without checking the Builder Dashboard. GET `/Company/Communities/Leads` pulls all company-scoped leads and GET `/Company/Communities/Leads/{LeadID}` retrieves detail for any lead the CRM needs to reconcile. Best for new-construction sales teams running per-community pipelines.

Example prompt: Call GET `/Company/Communities/Leads`, diff against the CRM, and POST any new leads to Salesforce as Lead records.

### Per-Development Lead Routing

Route leads to the right onsite sales team by pulling per-development leads rather than the company-wide list. GET `/Company/Communities/{DevelopmentID}/Leads` filters leads to a single development id, which matches how Builders typically assign sales reps. Reduces per-rep noise and removes the need for client-side filtering.

Example prompt: Call GET `/Company/Communities/{DevelopmentID}/Leads` for each active development and assign leads to the responsible rep based on community ownership.

### Appointment-Type Lead Tracking

Track high-intent appointment-type leads separately from general inquiries so that booked tours surface to sales reps immediately. GET `/Company/Communities/AppointmentsLeads/{AppointmentID}` returns the appointment-bound lead set and supports sales playbooks that prioritise booked-tour follow-up over passive form fills.

Example prompt: Call GET `/Company/Communities/AppointmentsLeads/{AppointmentID}` for each upcoming appointment and notify the assigned rep with lead context 24 hours ahead.

### AI Agent Lead Triage

Let an AI agent triage incoming Livabl leads - enrich them, route them to a rep, and update the CRM - without exposing the API key in the agent's context. Through Jentic, the agent searches by intent (e.g., 'pull new Livabl leads'), loads the schema, and executes the right `/Company/Communities/Leads` call. The API key stays in your Jentic One instance and gets swapped between communities when needed.

Example prompt: Search Jentic for 'pull new Livabl leads', load the schema, execute GET `/Company/Communities/Leads`, and route each new lead to the assigned sales rep in HubSpot.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/Company/ValidateKey` | Validate an API key |
| GET | `/Company/Communities/Leads` | Get all leads for a company |
| GET | `/Company/Communities/{DevelopmentID}/Leads` | Get leads for a development |
| GET | `/Company/Communities/Leads/{LeadID}` | Get an individual lead detail |
| GET | `/Company/Communities/AppointmentsLeads/{AppointmentID}` | Get appointment-type leads |
| GET | `/Company/Communities` | List company communities |
| GET | `/LivablPro/Leads` | Get Livabl Pro agent leads |

## Key resources

- **Company** — Company details, communities, and API key validation via `/Company/Details`, `/Company/Communities`, `/Company/ValidateKey`
- **Leads** — Company- and development-scoped lead retrieval and lead detail via `/Company/Communities/Leads` and `/Company/Communities/Leads/{LeadID}`
- **Appointments** — Appointment-type lead retrieval via `/Company/Communities/AppointmentsLeads/{AppointmentID}`
- **Livabl Pro** — Livabl Pro agent leads via `/LivablPro/Leads`

## Why Jentic

- **Setup:** Wiring the Livabl API by hand means setting up its API-key auth, validating the key with a preflight call, and handling retries yourself across builder-lead reads at api.livabl.com. Through Jentic you install once, import the Livabl API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Livabl puts the development and lead ids in the URL path (`/Company/Communities/{DevelopmentID}/Leads`, `/Leads/{LeadID}`), so a rule can pin your agent to reads for one development. Every operation here is a GET, so the agent retrieves lead and community data and performs no writes.
- **Credential handling:** Your Livabl API key is stored once, encrypted, by your own Jentic One instance and injected as the key parameter at execution time, even when swapping between per-community keys. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'pull leads for a development', and Jentic returns the matching Livabl operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot Account API** — CRM destination for synced Livabl Builder leads
- **Salesforce API** — Enterprise CRM destination for high-volume Builder sales teams
- **Pipedrive API** — Sales CRM with deal pipelines aligned to per-community sales reps

## FAQ

### Why is there no official OpenAPI spec for Livabl API?

Livabl does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Livabl API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Livabl API use?

Livabl uses API key authentication. Builder Dashboard accounts can generate up to 20 API keys, scoped per company or per community, in Settings > Integrations. Through Jentic, the key is held in your Jentic One instance and injected at execution time so agents never receive the raw value.

### Can I pull leads for a specific development with the Livabl API?

Yes. GET `/Company/Communities/{DevelopmentID}/Leads` returns leads scoped to a single development id, which matches how Builders typically assign onsite sales staff. For company-wide pulls use GET `/Company/Communities/Leads` instead.

### What are the rate limits for the Livabl API?

Rate limits are not formally published in the spec; access is gated by Featured/Verified Builder eligibility and per-key issuance. Build agents to poll on a per-minute or per-five-minute cadence rather than continuously, and prefer per-development calls when you only need a subset of leads.

### How do I sync Livabl leads through Jentic?

Run pip install jentic, then search for 'pull new Livabl leads'. Jentic returns GET `/Company/Communities/Leads.` Load the schema, execute, and diff the result against your CRM to detect new leads. For lead detail call GET `/Company/Communities/Leads/{LeadID}.`

### Can I limit what my agent is allowed to do with the Livabl API?

Yes. Because you run Jentic One yourself, your own rules decide which Livabl operations and credentials the agent may use. Every Livabl endpoint here is a GET, so you can allow the agent to read leads and community data while it performs no writes, and because the development and lead ids sit in the URL path (`/Company/Communities/{DevelopmentID}/Leads`, `/Company/Communities/Leads/{LeadID}`), a rule can pin the agent to a single development or to lead detail lookups only. You can also restrict which stored per-community API key is injected at execution time so the agent only ever reaches the communities you permit.