REST API

Build on top of Blue Reef.

REST API for teams that want to integrate custom workflows, pull data into internal tools, or extend BlueReef beyond what the UI offers. Workspace-scoped, key-authenticated, and documented.

bash — GET /v1/deals

$ curl -X GET https://api.bluereef.com/v1/deals/pln_12345 \
-H "Authorization: Bearer br_prod_xxxxxxxx"

{

"id": "pln_12345",

"status": "on_track",

"active_steps": [

{

"type": "email_draft",

"completed": false

}

],

"path_to_close": [ /* projected meetings */ ]

}

Read, write, and listen.

The API gives you programmatic access to your workspace data. Read deal plans, agent activity, tasks, and knowledge documents.

Write notes, create tasks, update deal status, and trigger agent actions. Listen for events via outbound webhooks—deal stage changes, plan updates, and call processing completions.

Every request is scoped to a workspace and authenticated with an API key. Rate-limited and logged the same way UI actions are. Full documentation at docs.bluereefai.com.