v1

latestOpenAPI 3.0.02026-07-2484509641.9 KB
Pulses

List Pulses

Returns the authenticated user's active pulses as a lightweight collection optimized for consumption by large language models (LLMs). Each entry includes a plain-text summary of the rendered content, priority, category, typed identity references for associated companies and contacts, and an optional context explanation.

Designed for AI / agent consumption. Dismissed, saved, and expired pulses are excluded.

Ordering

Results are returned in stable descending order of meta.createdAt, then by priority (HIGH first, then MEDIUM, then LOW), then by id ascending as a tiebreaker. The ordering is consistent across pages so pagination is safe under concurrent inserts.

get/agent/v1/pulses

Query parameters

page[size]integer

The number of pulses to return per page of results. Allowable values are between 1 and 100. The default value if not provided is 25 pulses per page.

page[number]integer

The page of results to fetch. The default value if not provided is 1 to fetch the first page of results.

Response

Success