Get an object
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas/{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/base-schemas/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Base schema retrieved successfully"
},
"data": {
"_id": "6730b1c4d3e5f6a7b8c9d0e1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Partners",
"slug": "partners",
"description": "Resellers and referral partners.",
"type": "custom",
"objectType": "partners",
"icon": "PiHandshake",
"viewType": "table",
"kanbanConfig": {
"_id": "6730b1c4d3e5f6a7b8c9d0e2",
"lanes": []
},
"fields": [
{
"id": "6730c2d5e4f6a7b8c9d0e1f2",
"sequence": 4,
"name": "partner_tier",
"displayName": "Partner tier",
"description": "Commercial tier agreed in the partner contract.",
"icon": "PiMedal",
"type": {
"type": "select",
"enum": [
"select"
],
"relationshipConfig": []
},
"settings": {
"selectOptions": [
{
"value": "Gold",
"color": "amber"
},
{
"value": "Silver",
"color": "gray"
},
{
"value": "Registered",
"color": "blue"
}
]
},
"isAIEnabled": false,
"isHiddenField": false,
"isReadOnly": false,
"isVisibleOnlyInPage": false,
"required": false,
"unique": false,
"validation": {
"rules": []
},
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"metadata": {
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
],
"agents": [],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:31: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>"
}
}Schemas
Get an object
Returns one object (base schema) with its fields. Fields whose permissions hide them from you are left out.
This response names the object’s id _id, where list, create and update name it id.
GET
/
v1
/
platform
/
base-schemas
/
{id}
Get an object
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas/{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/base-schemas/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Base schema retrieved successfully"
},
"data": {
"_id": "6730b1c4d3e5f6a7b8c9d0e1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Partners",
"slug": "partners",
"description": "Resellers and referral partners.",
"type": "custom",
"objectType": "partners",
"icon": "PiHandshake",
"viewType": "table",
"kanbanConfig": {
"_id": "6730b1c4d3e5f6a7b8c9d0e2",
"lanes": []
},
"fields": [
{
"id": "6730c2d5e4f6a7b8c9d0e1f2",
"sequence": 4,
"name": "partner_tier",
"displayName": "Partner tier",
"description": "Commercial tier agreed in the partner contract.",
"icon": "PiMedal",
"type": {
"type": "select",
"enum": [
"select"
],
"relationshipConfig": []
},
"settings": {
"selectOptions": [
{
"value": "Gold",
"color": "amber"
},
{
"value": "Silver",
"color": "gray"
},
{
"value": "Registered",
"color": "blue"
}
]
},
"isAIEnabled": false,
"isHiddenField": false,
"isReadOnly": false,
"isVisibleOnlyInPage": false,
"required": false,
"unique": false,
"validation": {
"rules": []
},
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"metadata": {
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
],
"agents": [],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"created": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:31: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>"
}
}In the Heliyos MCP server:
heliyos_fields_create, heliyos_fields_delete, heliyos_fields_update, heliyos_objects_get.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 object's id.
Pattern:
^[0-9a-fA-F]{24}$Was this page helpful?

