Skip to content
Breesy Documentation

Data Share API Overview

The Breesy Data Share API gives your organization programmatic access to your own Breesy data. The first release exposes voice-agent call data and a read/write Contacts (CRM) endpoint so you can sync calls, recordings, and contacts into your own systems.

This API is franchise-scoped and self-serve: a Power Admin creates and manages API keys directly from the Breesy app, and every key only ever sees data for that one franchise.

Base URL

Use the Breesy API domain for all Data Share API requests:

https://api.breesy.app

What The API Provides

  • GET /data/locations — discover the locations in your franchise so you can filter calls and contacts by location_id.
  • GET /data/calls — voice-agent call data including transcript, caller ID, timestamp, duration, agent type, customer details, call summary, location, real-estate data, loss type, referral source, notes, property area, callback number, call category, request type, and a signed recording URL.
  • GET / PATCH / POST /data/contacts — read, update, and create contacts in your CRM (name, email, phone, tags, notes, address, and more).

Query Scope

Each API key is bound to a single franchise. You do not pass a franchise_id — the franchise is derived from the key. Most endpoints accept an optional location_id to narrow results to one location.

Typical Workflow

  1. Call GET /data/locations to retrieve your location IDs.
  2. Call GET /data/calls (optionally filtered by location_id, date range, call ID, or phone number) to pull call data and recording URLs.
  3. Use GET / PATCH / POST /data/contacts to read and manage your contacts.