> ## 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 workspace Scout signals > Returns the signals one workspace Scout found across every company it runs on, most recently detected first, each with `companyName`. Signals of company Scouts that were deleted (for example when a company was unwatched or the Scout was edited to drop it) are not included. Paging works as in List signals (`GET /v1/platform/signals`): cursor by default, offset paging when you send `offset` or `page`. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_scouts_get`](https://docs.heliyos.ai/mcp/tools/scouts-and-signals#heliyos-scouts-get), [`heliyos_signals_list`](https://docs.heliyos.ai/mcp/tools/scouts-and-signals#heliyos-signals-list). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/platform/global-scouts/{id}/signals 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/global-scouts/{id}/signals: get: tags: - Signals summary: List workspace Scout signals description: >- Returns the signals one workspace Scout found across every company it runs on, most recently detected first, each with `companyName`. Signals of company Scouts that were deleted (for example when a company was unwatched or the Scout was edited to drop it) are not included. Paging works as in List signals (`GET /v1/platform/signals`): cursor by default, offset paging when you send `offset` or `page`. operationId: listGlobalScoutSignals parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The workspace Scout's id. example: 6731c0a2b4e5f60718293a4b - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: Signals per page, 1 to 100. Defaults to 20. example: 20 - name: cursor in: query required: false schema: type: string maxLength: 200 description: >- next_cursor from the previous page; only valid with the default sort. description: >- The `next_cursor` from the previous page. Takes precedence over `offset` and `page`. - name: page in: query required: false schema: type: integer minimum: 1 description: >- A page number, starting at 1, for offset paging. Ignored when `offset` is sent. - name: offset in: query required: false schema: type: integer minimum: 0 description: The number of signals to skip, for offset paging. - name: status in: query required: false schema: type: string enum: - new - read - archived description: 'Only signals in this status: `new` (unread), `read` or `archived`.' example: new - name: startDate in: query required: false schema: type: string format: date-time description: Only signals detected at or after this ISO 8601 date-time. example: '2026-10-01T00:00:00.000Z' - name: endDate in: query required: false schema: type: string format: date-time description: Only signals detected at or before this ISO 8601 date-time. example: '2026-11-01T00:00:00.000Z' - name: companyId in: query required: false schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: >- Only signals about this company record. A company the Scout does not run on returns an empty list. example: 66f1a8c3e4b0a1b2c3d4e5f6 responses: '200': description: A page of the Scout's signals. 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. pagination: $ref: '#/components/schemas/KeysetPagination' data: type: array items: $ref: '#/components/schemas/SignalWithCompany' example: meta: message: Signals retrieved successfully pagination: limit: 20 next_cursor: NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2 data: - _id: 6735a9d1e2f3a4b5c6d7e8fa organizationId: 66a0f1e2d3c4b5a697887766 scoutSchemaId: 6732d4e5f6a7b8c9d0e1f2a3 baseSchemaObjectId: 66f1a8c3e4b0a1b2c3d4e5f6 category: Hiring scout_name: Hiring for data roles scope: watchlist summary: >- Northwind Traders posted three senior data engineer roles in Lisbon. citations: - https://careers.northwind.example.com/jobs/data-engineer relevance_score: 72 source: scouts detected_date: '2026-11-03T06:00:00.000Z' status: new companyName: Northwind Traders '400': description: >- VALIDATION_FAILED: a parameter is invalid, or the cursor is invalid or points at a signal that no longer exists. 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 workspace Scout 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: KeysetPagination: type: object description: >- Cursor paging. Pass `next_cursor` back as `cursor` with the same `limit` for the next page. required: - limit properties: limit: type: integer description: The page size used for this page. example: 20 next_cursor: type: string description: Cursor for the next page. Absent on the last page. SignalWithCompany: description: A signal with the name of the company it is about. allOf: - $ref: '#/components/schemas/Signal' - type: object properties: companyName: type: string description: >- The company record's `company_name` (or `name`, or `Unknown`) for watched companies, otherwise the name the Scout reported. Absent when neither is known. 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: {} Signal: type: object description: One finding of a Scout. properties: _id: $ref: '#/components/schemas/ObjectId' organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace. scoutSchemaId: allOf: - $ref: '#/components/schemas/ObjectId' description: >- The company Scout that found it (see `CompanyScout`). Its `defaultScoutId` is the workspace Scout. baseSchemaObjectId: allOf: - $ref: '#/components/schemas/ObjectId' description: >- The company record the signal is about. Absent for signals of `entire_web` Scouts. category: type: string description: >- The Scout's category when the signal was found, for example `Growth & Expansion`. scout_name: type: string description: The Scout's name when the signal was found. scope: type: string enum: - watchlist - entire_web description: '`entire_web` for signals of web-wide Scouts, `watchlist` otherwise.' company_name: type: string description: >- The company name the Scout reported. May be absent; for watched companies use `baseSchemaObjectId`. website: type: string description: >- The company's website the Scout reported, normalized to the site address. May be absent. summary: type: string description: What happened, in a sentence or two. citations: type: array description: Source URLs that support the signal. items: type: string format: uri relevance_score: type: integer minimum: 0 maximum: 100 description: >- How relevant the Scout judged the signal, 0 to 100. 0 when the Scout gave no score. confidence_score: type: number description: >- The raw score the Scout reported, either 0 to 1 or 0 to 100. Prefer `relevance_score`. source: type: string enum: - scouts - leadsets - linkedin description: What produced the signal. Scouts write `scouts`. detected_date: allOf: - $ref: '#/components/schemas/Timestamp' description: >- When the event was detected. For custom Scouts, the time of the run that found it. Lists sort on it. status: type: string enum: - new - read - archived description: >- `new` (unread), `read`, or `archived`. This API sets `read`; it does not archive. raw_output: type: object additionalProperties: true description: >- The Scout's structured output for this signal, in the shape of its output schema. eventId: type: string description: The id of the detection event. Internal; unique per run. parallelMonitorId: type: string description: The id of the monitor or run that produced the signal. Internal. taskRunId: type: string description: >- The id of the custom Scout run that produced the signal. Internal; absent for built-in Scouts. webhook_timestamp: type: string description: When the result was delivered. Internal. metadata: $ref: '#/components/schemas/ScoutAuditMetadata' 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' 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.