curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/notes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/notes', 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/notes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Notes fetched successfully.",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6720b1f4c2a9e3d1f0a4b5c6",
"organizationId": "66a0f1e2d3c4b5a697887766",
"title": "Pricing call follow-up",
"content": "Champion confirmed budget for Q1. Procurement wants a security review first.",
"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 notes
Returns the workspace’s notes, newest first.
By default the list pages with a cursor: pass limit, then send meta.pagination.next_cursor
back as cursor for the next page. To filter, search or sort, send a JSON filters object.
A custom sort or page switches to page-number paging. See Pagination
and Filtering and sorting.
To list only the notes linked to one record, send {"relatedObjectId": "<record id>"} in filters.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/notes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/notes', 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/notes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Notes fetched successfully.",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6720b1f4c2a9e3d1f0a4b5c6",
"organizationId": "66a0f1e2d3c4b5a697887766",
"title": "Pricing call follow-up",
"content": "Champion confirmed budget for Q1. Procurement wants a security review first.",
"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_notes_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
Notes 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 page.
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 notes long.
x >= 1A JSON object, URL-encoded. Keys:
search(string): matches text in the title or body, case-insensitive.relatedObjectId(id): only notes linked to this record, task or interaction.filters(array): conditions{ "field", "operator", "value" }. Fields:title,content,metadata.created.at,metadata.created.by. Operators:equals,not_equals,contains,after,before,gt,gte,lt,lte,in,empty,not_empty.sort(array):{ "field", "direction" }with directionascordesc, for example[{"field": "metadata.updated.at", "direction": "desc"}]. JSON-encoded filter object (search, filters, sort, page, pageSize). Optional. pageSize above 200 is clamped to 200.
20000Was this page helpful?

