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

MethodPathScopeWhat it does
GET/v1/accountsaccounts:readList accounts
GET/v1/accounts/{key}accounts:readGet one account
POST/v1/collectionscollections:writeCreate a list
GET/v1/content/ideas/{id}/export.zipexport:readDownload an idea's content as a zip
GET/v1/exports/accounts.csvexport:readExport accounts as CSV
GET/v1/exports/pipeline.csvexport:readExport the pipeline as CSV
GET/v1/exports/signals.csvexport:readExport signals as CSV
GET/v1/listenerslisteners:readList listeners
GET/v1/listeners/{id}listeners:readGet one listener
POST/v1/listeners/analyse-websitelisteners:analyseDerive a listener plan from a website
POST/v1/notescollections:writeWrite a note
GET/v1/pipelinepipeline:readList deals
POST/v1/pipelinepipeline:writeAdd a deal
PATCH/v1/pipeline/{id}pipeline:writeUpdate a deal
POST/v1/pipeline/bulkpipeline:writeAdd several deals at once
GET/v1/pipeline/roipipeline:readPipeline return over a window
GET/v1/resultssignals:readList signals
GET/v1/results/statssignals:readCount signals in a window
POST/v1/signals/{id}/savecollections:writeSave a signal to a list

Next

  • Developers — Authentication, scopes and the MCP server.
  • openapi.json — The machine-readable description of these endpoints.

See also