Back to Docs

API Reference

The FlexPulse AI REST API gives you programmatic access to your portfolio data, metrics, and forecasts. Use it to build custom dashboards, automate reporting, or integrate with your existing BI tools.

Public API — Coming Soon

The public API is currently in private beta. Join the waitlist to get early access and shape the API design. Request access →

Authentication

All API requests must include a bearer token in the Authorization header. You can generate API keys from your organization settings once the API is out of beta.

Authorization: Bearer fp_live_xxxxxxxxxxxxxxxxxxxxxxxx

Base URL

https://api.flexpulse.ai

Endpoints

GET
/v1/locations

List all locations in your organization.

GET
/v1/locations/:id/metrics

Retrieve metric data for a specific location and date range.

GET
/v1/locations/:id/forecast

Get the current AI forecast for occupancy and MRR.

POST
/v1/locations/:id/metrics

Submit metric data programmatically (e.g., from your own system).

GET
/v1/portfolio/summary

Portfolio-wide aggregate metrics and KPIs.

GET
/v1/integrations

List all active integrations for your organization.

Rate Limits

PlanRate limit
Starter100 requests / minute
Growth500 requests / minute
EnterpriseCustom — contact sales

Get early API access

Join the private beta and help shape the FlexPulse AI API.

Request access