API reference — Open Pulse
Every endpoint under https://api.openpulse.cloud/v1, with the scope each one requires. Generated from the OpenAPI document, which is generated from the route table.
What this page answers
Where is the machine-readable API description?
https://api.openpulse.cloud/openapi.json — an OpenAPI 3.1 document generated from the real routes. Prefer it to this page for anything you intend to generate a client from; this is the same information rendered for reading.
How many endpoints are there?
19, listed below with their methods, paths and scopes.
What is the base URL?
https://api.openpulse.cloud/v1. Authentication is a bearer token carrying a workspace API key.
Endpoints
| Method | Path | Scope | What it does |
|---|---|---|---|
| GET | /v1/accounts | accounts:read | List accounts |
| GET | /v1/accounts/{key} | accounts:read | Get one account |
| POST | /v1/collections | collections:write | Create a list |
| GET | /v1/content/ideas/{id}/export.zip | export:read | Download an idea's content as a zip |
| GET | /v1/exports/accounts.csv | export:read | Export accounts as CSV |
| GET | /v1/exports/pipeline.csv | export:read | Export the pipeline as CSV |
| GET | /v1/exports/signals.csv | export:read | Export signals as CSV |
| GET | /v1/listeners | listeners:read | List listeners |
| GET | /v1/listeners/{id} | listeners:read | Get one listener |
| POST | /v1/listeners/analyse-website | listeners:analyse | Derive a listener plan from a website |
| POST | /v1/notes | collections:write | Write a note |
| GET | /v1/pipeline | pipeline:read | List deals |
| POST | /v1/pipeline | pipeline:write | Add a deal |
| PATCH | /v1/pipeline/{id} | pipeline:write | Update a deal |
| POST | /v1/pipeline/bulk | pipeline:write | Add several deals at once |
| GET | /v1/pipeline/roi | pipeline:read | Pipeline return over a window |
| GET | /v1/results | signals:read | List signals |
| GET | /v1/results/stats | signals:read | Count signals in a window |
| POST | /v1/signals/{id}/save | collections:write | Save a signal to a list |
Next
- Developers — Authentication, scopes and the MCP server.
- openapi.json — The machine-readable description of these endpoints.