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

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

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

The next_cursor from the previous page. Only valid with the default order (newest first) and no sort. 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 files long, or filters.pageSize when sent.

Required range: x >= 1
kind
enum<string>

Which files to list:

  • knowledge_base: knowledge base files only.
  • attachment: files attached to resources only.

Omit for both. Takes precedence over isKbFile in filters.

Available options:
knowledge_base,
attachment
filters
string

A JSON object, URL-encoded. Keys:

  • search (string): matches text in the file name or content type, case-insensitive.
  • objectId (id): only files attached to this record, task or other resource. relationshipObjectId does the same.
  • isKbFile (boolean): true for knowledge base files, false for the others.
  • filters (array, up to 500): conditions { "field", "operator", "value" }. Useful fields: fileName, mimeType, fileSize, description. Operators: equals, not_equals, contains, gt, gte, lt, lte. Any other operator is ignored. All conditions must match.
  • sort (array): { "field", "direction" } with direction asc or desc. Switches to page-number paging.
  • page, pageSize (integers from 1): page-number paging. pageSize above 200 is lowered to 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 files.

meta
object
required
data
object[]
required