> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Watch a company > Adds a company record to the watchlist. Watching an already watched company changes nothing and uses no Watcher. When the company was not watched yet: - It uses one Watcher from your plan. With none left, the call answers 403 and nothing changes. - Its `account_status` and `engagement_status` are set to `unknown` if empty, and the records linked to it (for example its people and deals) are marked watched too. - In the background, the workers enrich it and pull in its emails and meetings (enrichment uses credits), and every active Scout scoped to the watchlist starts on it. Custom Scouts cost credits per run. Background steps that fail do not fail the call. Check progress in `agentAssignmentStatus` and with `GET /v1/platform/companies/{id}/scouts`. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_companies_watch`](https://docs.heliyos.ai/mcp/tools/watchlist#heliyos-companies-watch). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/platform/companies/{id}/watch openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/platform/companies/{id}/watch: post: tags: - Watchlist summary: Watch a company description: >- Adds a company record to the watchlist. Watching an already watched company changes nothing and uses no Watcher. When the company was not watched yet: - It uses one Watcher from your plan. With none left, the call answers 403 and nothing changes. - Its `account_status` and `engagement_status` are set to `unknown` if empty, and the records linked to it (for example its people and deals) are marked watched too. - In the background, the workers enrich it and pull in its emails and meetings (enrichment uses credits), and every active Scout scoped to the watchlist starts on it. Custom Scouts cost credits per run. Background steps that fail do not fail the call. Check progress in `agentAssignmentStatus` and with `GET /v1/platform/companies/{id}/scouts`. operationId: watchCompany parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The company record's id. example: 66f1a8c3e4b0a1b2c3d4e5f6 responses: '200': description: The company record, now watched. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: $ref: '#/components/schemas/WatchedCompanyRecord' example: meta: message: Company watched. data: _id: 66f1a8c3e4b0a1b2c3d4e5f6 organizationId: 66a0f1e2d3c4b5a697887766 baseSchemaId: 66a0f1e2d3c4b5a697880001 objectType: company data: company_name: Northwind Traders website: https://northwind.example.com account_status: unknown engagement_status: unknown isAgentAssigned: true agentAssignmentStatus: STARTED enrichmentStatus: FINISHED relationships: - objectId: 66f1a8c3e4b0a1b2c3d4e600 schemaId: 66a0f1e2d3c4b5a697880002 objectType: people metadata: created: at: '2026-09-12T10:00:00.000Z' by: 66a0f1e2d3c4b5a697881111 updated: at: '2026-11-04T09:30:00.000Z' by: 66a0f1e2d3c4b5a697881111 '400': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- FORBIDDEN: no Watchers left on your plan (or no active plan): `Watched accounts limit reached. Upgrade your plan to watch more companies.` Also returned when you cannot edit the companies object. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- NOT_FOUND: no record with this id in the workspace, or the record is not a company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: WatchedCompanyRecord: type: object additionalProperties: true description: The company record after the change. properties: _id: $ref: '#/components/schemas/ObjectId' organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace. baseSchemaId: allOf: - $ref: '#/components/schemas/ObjectId' description: The record's object (base schema), your companies object. objectType: type: string description: Always `company`. data: type: object additionalProperties: true description: >- The record's field values, keyed by field name (for example `company_name`, `website`, `account_status`, `engagement_status`). isAgentAssigned: type: boolean description: >- Whether the company is watched. `true` after watching, `false` after unwatching. agentAssignmentStatus: type: string nullable: true enum: - STARTED - FINISHED - FAILED - null description: >- How taking the account on is going: `STARTED` when watched, `FINISHED` once the workers have enriched it and pulled in its history, `FAILED` if that did not complete. Null after unwatching. enrichmentStatus: type: string description: '`NOT_ENRICHED`, `STARTED`, `FINISHED` or `FAILED`. May be absent.' enrichmentDate: allOf: - $ref: '#/components/schemas/Timestamp' nullable: true description: When enrichment last started. relationships: type: array description: The records linked to the company. items: type: object additionalProperties: true properties: objectId: $ref: '#/components/schemas/ObjectId' schemaId: $ref: '#/components/schemas/ObjectId' objectType: type: string description: '`people`, `deals` or a custom object type.' metadata: type: object description: Who created and last changed the record, and when. properties: created: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: type: string description: Id of the user who created it. updated: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: type: string description: Id of the user who last changed it. ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.