Skip to main content
GET
List interactions
In the Heliyos MCP server: heliyos_interactions_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.

Query Parameters

limit
integer
default:20

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

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

The next_cursor from the previous page. Only valid without a sort (a 400 otherwise). When you send both cursor and page, cursor wins. 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 page-number paging. Pages are limit interactions long.

Required range: x >= 1
filters
string

A JSON object, URL-encoded. Keys:

  • objectId (id): only interactions linked to this record.
  • channelType (string or array): email, meeting, or both (an array or a comma-separated string).
  • categoryIds (string or array): only interactions with any of these label ids.
  • search (string): case-insensitive text match on the subject, title, summary, message previews, takeaways, transcript and participant addresses.
  • uniqByRelationships (any non-empty value): keep one interaction per distinct set of linked records.
  • sort (array): { "field", "direction" } with direction asc or desc. Useful fields: thread_date (newest email message), start_time (meeting start), createdAt (when synced).
  • filters (array): conditions { "field", "operator", "value", "conjunction" }. Conditions with "conjunction": "and" must all match. Conditions without it, or with "or", are combined with OR, so set "conjunction": "and" on every condition you need to hold. Operators: equals, not_equals, contains, not_contains, starts_with, ends_with, empty, not_empty, in, not_in, greater_than, less_than, greater_than_equal, less_than_equal, after, before, between (value {"startDate","endDate"} as a JSON string), and is / is_not for participants. Special fields: channelType, categoryIds, participants (meeting invitee addresses), hasAgentDraft (true for threads holding a worker's unsent draft), and relationships.<objectType>.<field> to match a linked record's field value, for example relationships.company.company_name.
  • page and pageSize: page-number paging. pageSize is capped at 200. JSON-encoded filter object (search, filters, sort, page, pageSize). Optional. pageSize above 200 is clamped to 200.
Maximum string length: 20000

Response

A page of interactions.

meta
object
required
data
object[]
required