Docs › Distribute and automate

Integrations and API

Sync live inventory to WordPress or any website with API keys, embed forms, and connect Google Calendar.

Go to Settings › API & integrations. API keys need the Growth plan or above; managing keys and embeds is limited to owners and admins.

API keys

Under API keys, type a label that says where the key will be used, for example "WordPress site".
Select Generate key.
Copy the key straight away and store it somewhere safe. It starts with bf_.

Revoke a key from its row when a site no longer needs it; requests using it stop working immediately.

Public API

The API is read-only and returns your live inventory as JSON. Send the key in the Authorization header.

List your projects, or the units of one project by the project's slug:

GET /api/public/projects
GET /api/public/units?project=<slug>
GET /api/public/availability?project=<slug>
Authorization: Bearer bf_…

Projects include their name, slug, location, status, cover image, gallery and project fields. Units include number, type, bedrooms, bathrooms, areas, price, status, floor plan, images and unit fields. The availability endpoint returns a project's availability map: its views, shapes and each unit's floor, status and price.

Note: Only custom fields marked Include in the public API / WordPress sync are returned. Buyers, leads, documents and internal fields are never part of the API. See Units and custom fields.

OpenAPI document

A machine-readable description of the API and of webhook events, in OpenAPI 3.1, is at /api/public/openapi.json on your bildflow address. It needs no key. Import it into Postman, Insomnia or a code generator.

WordPress

Point your WordPress site's inventory sync, or any custom code, at the endpoints above with an API key. The plugin's [bildflow_availability] shortcode shows the availability map. Because the data is read live, a unit marked Sold in bildflow shows as sold on your site on its next request.

Webhooks

Send a signed event to your own server, Zapier, Make or n8n when a lead arrives, a unit changes status, a reservation is signed, a payment is recorded or a viewing is booked. See Webhooks.

Property portals

Send your available units to Kyero and other portals with a feed URL under Property portals. See Property portal feeds.

Embedded forms

The Embed on your website card gives you the enquiry-form and booking-widget snippets. See Embeddable forms.

Google Calendar

Calendar sync is set up per person under Settings › Viewing bookings. See Viewing bookings.