curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/attachments \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/attachments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/attachments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Attachments fetched successfully.",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6729c0d4e5f6a7b8c9d0e1f2",
"id": "6729c0d4e5f6a7b8c9d0e1f2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"fileName": "pricing-2026.pdf",
"fileSize": 482113,
"mimeType": "application/pdf",
"url": "https://example-bucket.s3.amazonaws.com/66a0f1e2d3c4b5a697887766/objects/company/1762248600000-pricing-2026.pdf",
"storageProvider": "S3",
"storageKey": "66a0f1e2d3c4b5a697887766/objects/company/1762248600000-pricing-2026.pdf",
"isKbFile": false,
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company"
}
],
"metadata": {
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}List files
Returns the workspace’s files, newest first: knowledge base files and files attached to
resources. Use kind to list only one of the two.
By default the list pages with a cursor: pass limit, then send meta.pagination.next_cursor
back as cursor for the next page. A sort or page in filters, or the page parameter,
switches to page-number paging, sorted by creation date (newest first) unless you sort, with
meta.pagination holding page, limit, totalPages, count and hasMore. See
Pagination and Filtering and sorting.
To list the files attached to one record, send {"objectId": "<record id>"} in filters.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/attachments \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/attachments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/attachments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Attachments fetched successfully.",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6729c0d4e5f6a7b8c9d0e1f2",
"id": "6729c0d4e5f6a7b8c9d0e1f2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"fileName": "pricing-2026.pdf",
"fileSize": 482113,
"mimeType": "application/pdf",
"url": "https://example-bucket.s3.amazonaws.com/66a0f1e2d3c4b5a697887766/objects/company/1762248600000-pricing-2026.pdf",
"storageProvider": "S3",
"storageKey": "66a0f1e2d3c4b5a697887766/objects/company/1762248600000-pricing-2026.pdf",
"isKbFile": false,
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company"
}
],
"metadata": {
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_files_list.Authorizations
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
Files per page, 1 to 100. Defaults to 20.
1 <= x <= 100The 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.
200A page number, starting at 1, for page-number paging. Pages are limit files long, or filters.pageSize when sent.
x >= 1Which files to list:
knowledge_base: knowledge base files only.attachment: files attached to resources only.
Omit for both. Takes precedence over isKbFile in filters.
knowledge_base, attachment 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.relationshipObjectIddoes the same.isKbFile(boolean):truefor knowledge base files,falsefor 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 directionascordesc. Switches to page-number paging.page,pageSize(integers from 1): page-number paging.pageSizeabove 200 is lowered to 200. JSON-encoded filter object (search, filters, sort, page, pageSize). Optional. pageSize above 200 is clamped to 200.
20000Was this page helpful?

