Write and destructive tools change your workspace. Clients that support it ask before they run.
Get the watchlist
heliyos_watchlist_get · Read · Idempotent
Lists the companies on the watchlist (the accounts the workers monitor with Scouts and keep enriched), most recently created records first (not by watch date), with their ids, names and key fields. “detailed” also returns watchlist statistics on the first page: tasks done, deals, meetings and actions across watched companies. Use heliyos_companies_watch / _unwatch to change it. Returns structuredContent {companies:[{id, name, fields}], statistics?, next_cursor}.
Inputs
integer
default:"20"
Companies per page, 1 to 100. Default 20. From 1 to 100.
string
next_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.
string
default:"concise"
“concise” (default) returns companies with key fields; “detailed” returns every field plus watchlist statistics. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with companies, statistics, next_cursor.
API endpoints
- List records ·
GET /v1/platform/base-schemas/{id}/records - Get watchlist statistics ·
GET /v1/platform/watchlist/statistics
Watch a company
heliyos_companies_watch · Write · Idempotent
Adds a company record to the watchlist: the workers enrich it, pull in its emails and meetings, and start its Scouts. Counts against the plan’s watched-company limit (heliyos_organization_get) and uses credits for enrichment. Watching an already watched company changes nothing. Returns structuredContent {record_id, watched}.
Inputs
string
required
The company record’s id (from heliyos_records_list or _lookup). A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with record_id, watched.
API endpoints
- Watch a company ·
POST /v1/platform/companies/{id}/watch
Unwatch a company
heliyos_companies_unwatch · Destructive · Idempotent
Removes a company record from the watchlist. Its Scouts are deleted and the workers stop monitoring it; its history (emails, meetings, notes, signals) is kept, so watching it again resumes where it left off. Confirm with the user first. Returns structuredContent {record_id, watched}.
Inputs
string
required
The company record’s id (from heliyos_records_list or _lookup). A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with record_id, watched.
API endpoints
- Unwatch a company ·
DELETE /v1/platform/companies/{id}/watch

