Get a record
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/records/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}', 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/records/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Object fetched successfully"
},
"data": {
"_id": "6721c3d5e6f7a8b9c0d1e2f3",
"id": "6721c3d5e6f7a8b9c0d1e2f3",
"baseSchemaId": "66a0f1e2d3c4b5a697880003",
"organizationId": "66a0f1e2d3c4b5a697887766",
"objectType": "deals",
"data": {
"deal_name": "Northwind Traders renewal",
"stage": "Negotiation",
"deal_value": 48000,
"close_date": "2026-12-15"
},
"relationships": [
{
"_id": "6721c3d5e6f7a8b9c0d1e2f4",
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"fullData": {
"_id": "66f1a8c3e4b0a1b2c3d4e5f6",
"baseSchemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"data": {
"company_name": "Northwind Traders",
"website": "https://northwind.example"
}
}
}
],
"notes": [
{
"_id": "6720b1f4c2a9e3d1f0a4b5c6",
"title": "Pricing call follow-up",
"content": "Champion confirmed budget for Q1."
}
],
"tasks": [],
"isAgentAssigned": false,
"aiColumnStatus": {},
"metadata": {
"created": {
"at": "2026-11-02T14:10: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>"
}
}Records
Get a record
Returns one record by id, from any object. Record ids are unique across objects.
data holds only the object’s fields; a field you may not view is null. Each entry in
relationships carries the complete linked record in fullData. The response also includes every
note (notes) and task (tasks) linked to the record, newest first.
GET
/
v1
/
platform
/
records
/
{id}
Get a record
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/records/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}', 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/records/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Object fetched successfully"
},
"data": {
"_id": "6721c3d5e6f7a8b9c0d1e2f3",
"id": "6721c3d5e6f7a8b9c0d1e2f3",
"baseSchemaId": "66a0f1e2d3c4b5a697880003",
"organizationId": "66a0f1e2d3c4b5a697887766",
"objectType": "deals",
"data": {
"deal_name": "Northwind Traders renewal",
"stage": "Negotiation",
"deal_value": 48000,
"close_date": "2026-12-15"
},
"relationships": [
{
"_id": "6721c3d5e6f7a8b9c0d1e2f4",
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"fullData": {
"_id": "66f1a8c3e4b0a1b2c3d4e5f6",
"baseSchemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"data": {
"company_name": "Northwind Traders",
"website": "https://northwind.example"
}
}
}
],
"notes": [
{
"_id": "6720b1f4c2a9e3d1f0a4b5c6",
"title": "Pricing call follow-up",
"content": "Champion confirmed budget for Q1."
}
],
"tasks": [],
"isAgentAssigned": false,
"aiColumnStatus": {},
"metadata": {
"created": {
"at": "2026-11-02T14:10: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>"
}
}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.
Path Parameters
The record's id.
Pattern:
^[0-9a-fA-F]{24}$Was this page helpful?

