Skip to main content
GET
List workspace Scout signals
In the Heliyos MCP server: heliyos_scouts_get, heliyos_signals_list.

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
string
required

The workspace Scout's id.

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

limit
integer
default:20

Signals per page, 1 to 100. Defaults to 20.

Required range: 1 <= x <= 100
cursor
string

The next_cursor from the previous page. Takes precedence over offset and page. next_cursor from the previous page; only valid with the default sort.

Maximum string length: 200
page
integer

A page number, starting at 1, for offset paging. Ignored when offset is sent.

Required range: x >= 1
offset
integer

The number of signals to skip, for offset paging.

Required range: x >= 0
status
enum<string>

Only signals in this status: new (unread), read or archived.

Available options:
new,
read,
archived
startDate
string<date-time>

Only signals detected at or after this ISO 8601 date-time.

endDate
string<date-time>

Only signals detected at or before this ISO 8601 date-time.

companyId
string

Only signals about this company record. A company the Scout does not run on returns an empty list.

Pattern: ^[0-9a-fA-F]{24}$

Response

A page of the Scout's signals.

meta
object
required
data
object[]
required