> ## 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. # List company Scouts > Returns the Scouts running on one company, newest first. Each entry is a company Scout: a copy of a workspace Scout (`defaultScoutId`) for this company. The list is not paged. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_companies_scouts_list`](https://docs.heliyos.ai/mcp/tools/scouts-and-signals#heliyos-companies-scouts-list). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/platform/companies/{id}/scouts 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}/scouts: get: tags: - Scouts summary: List company Scouts description: >- Returns the Scouts running on one company, newest first. Each entry is a company Scout: a copy of a workspace Scout (`defaultScoutId`) for this company. The list is not paged. operationId: listCompanyScouts parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The company record's id. example: 66f1a8c3e4b0a1b2c3d4e5f6 - name: status in: query required: false schema: type: string enum: - active - paused - failed description: 'Only company Scouts in this status: `active`, `paused` or `failed`.' example: active responses: '200': description: The company's Scouts. 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: type: array items: $ref: '#/components/schemas/CompanyScout' example: meta: message: Scouts retrieved successfully data: - _id: 6732d4e5f6a7b8c9d0e1f2a3 organizationId: 66a0f1e2d3c4b5a697887766 baseSchemaObjectId: 66f1a8c3e4b0a1b2c3d4e5f6 defaultScoutId: 6731c0a2b4e5f60718293a4b scoutType: custom executionMode: task effort: medium name: Hiring for data roles category: Hiring query: >- Find data for the company Northwind Traders with the website https://northwind.example.com. New job postings at the company for data engineering or analytics roles. queryTemplate: >- New job postings at the company for data engineering or analytics roles. cadence: weekly scope: watchlist status: active lastRunDate: '2026-11-03T06:00:00.000Z' metadata: created: at: '2026-10-02T08:20:00.000Z' by: system updated: at: '2026-11-03T06:00:00.000Z' by: system '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 content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: 'NOT_FOUND: no record with this id in the workspace.' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: CompanyScout: type: object description: > A workspace Scout running on one company (or, for an `entire_web` Scout, on the web). It copies its workspace Scout's fields; change them on the workspace Scout. properties: _id: $ref: '#/components/schemas/ObjectId' organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace. baseSchemaObjectId: allOf: - $ref: '#/components/schemas/ObjectId' description: The company record it runs on. Absent for an `entire_web` Scout. defaultScoutId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace Scout it is a copy of. scoutType: type: string enum: - default - custom description: The workspace Scout's type. executionMode: type: string enum: - monitor - task description: >- `monitor` for built-in Scouts (continuous monitoring), `task` for custom Scouts (one run per cadence period, charged in credits). effort: type: string nullable: true enum: - low - medium - high - null description: Search depth of a custom Scout. Null on built-in Scouts. name: type: string description: The workspace Scout's name. category: type: string description: The workspace Scout's category. query: type: string description: The query as it runs, with the company's name and website added. queryTemplate: type: string description: The workspace Scout's query. cadence: type: string enum: - daily - weekly - monthly description: How often it runs. scope: type: string enum: - watchlist - entire_web description: '`entire_web` for a web-wide Scout, `watchlist` otherwise.' status: type: string enum: - active - paused - failed description: >- `active` while running, `paused` while its workspace Scout is paused, `failed` when it could not run. lastRunDate: allOf: - $ref: '#/components/schemas/Timestamp' nullable: true description: When it last ran. Null before its first run. lastRunId: type: string nullable: true description: The id of its last run. outputSchema: $ref: '#/components/schemas/ScoutOutputSchema' metadata: $ref: '#/components/schemas/ScoutAuditMetadata' additionalProperties: true 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' ScoutOutputSchema: type: object additionalProperties: true description: > The structured output a custom Scout asks for on each run, as `{ "type": "json", "json_schema": { ... } }` where `json_schema` is a JSON Schema object. The default asks for a `signals` array (each item with `company_name`, `website`, `summary` and `sources`), plus `total_count` and `query_summary`. Built-in Scouts carry their own fixed schema. example: type: json json_schema: type: object properties: signals: type: array items: type: object properties: company_name: type: string website: type: string summary: type: string sources: type: array items: type: string required: - summary total_count: type: number query_summary: type: string required: - signals ScoutAuditMetadata: type: object description: >- When the Scout was created and last changed. `by` is a service label such as `system`, not a user id. properties: created: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: type: string description: Who created it, for example `system`. updated: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: type: string description: Who last changed it, for example `system`. 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.