List objects
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Schemas retrieved successfully"
},
"data": [
{
"id": "66a0f1e2d3c4b5a697880001",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Company",
"slug": "company",
"description": "Master data for companies",
"type": "base",
"objectType": "company",
"viewType": "table",
"fields": [
{
"id": "674af8e0017b924c5d1d69b2",
"sequence": 1,
"name": "company_name",
"displayName": "Company",
"type": {
"type": "relationship",
"enum": [
"relationship",
"text"
]
},
"required": true,
"isAIEnabled": false,
"isHiddenField": false,
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"hasAccess": true
}
],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"recordCount": 412,
"created": {
"at": "2026-01-12T08:00:00.000Z",
"by": "system"
},
"updated": {
"at": "2026-10-02T14:21:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
},
{
"id": "6730b1c4d3e5f6a7b8c9d0e1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Partners",
"slug": "partners",
"type": "custom",
"objectType": "partners",
"viewType": "table",
"fields": [
{
"id": "6730c2d5e4f6a7b8c9d0e1f2",
"sequence": 4,
"name": "partner_tier",
"displayName": "Partner tier",
"type": {
"type": "select",
"enum": [
"select"
]
},
"settings": {
"selectOptions": [
{
"value": "Gold",
"color": "amber"
},
{
"value": "Silver",
"color": "gray"
}
]
},
"required": false,
"isAIEnabled": false,
"isHiddenField": false,
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"hasAccess": true
}
],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"recordCount": 18,
"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>"
}
}Schemas
List objects
Returns every object (base schema) in the workspace that you may view, with its fields, oldest first: companies, people, each deal pipeline and your custom objects. The list is not paginated; a workspace has a handful of objects.
Use it to find an object’s id (records call it schemaId) and its field keys. Fields whose
permissions hide them from you are left out of each object.
GET
/
v1
/
platform
/
base-schemas
List objects
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Schemas retrieved successfully"
},
"data": [
{
"id": "66a0f1e2d3c4b5a697880001",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Company",
"slug": "company",
"description": "Master data for companies",
"type": "base",
"objectType": "company",
"viewType": "table",
"fields": [
{
"id": "674af8e0017b924c5d1d69b2",
"sequence": 1,
"name": "company_name",
"displayName": "Company",
"type": {
"type": "relationship",
"enum": [
"relationship",
"text"
]
},
"required": true,
"isAIEnabled": false,
"isHiddenField": false,
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"hasAccess": true
}
],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"recordCount": 412,
"created": {
"at": "2026-01-12T08:00:00.000Z",
"by": "system"
},
"updated": {
"at": "2026-10-02T14:21:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
},
{
"id": "6730b1c4d3e5f6a7b8c9d0e1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Partners",
"slug": "partners",
"type": "custom",
"objectType": "partners",
"viewType": "table",
"fields": [
{
"id": "6730c2d5e4f6a7b8c9d0e1f2",
"sequence": 4,
"name": "partner_tier",
"displayName": "Partner tier",
"type": {
"type": "select",
"enum": [
"select"
]
},
"settings": {
"selectOptions": [
{
"value": "Gold",
"color": "amber"
},
{
"value": "Silver",
"color": "gray"
}
]
},
"required": false,
"isAIEnabled": false,
"isHiddenField": false,
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"hasAccess": true
}
],
"permissions": {
"visibility": "organization",
"editableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
},
"viewableBy": {
"roles": [
"OWNER",
"ADMIN",
"MEMBER",
"STAFF",
"SUPPORT",
"SUPER_ADMIN"
],
"users": []
}
},
"recordCount": 18,
"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>"
}
}In the Heliyos MCP server:
heliyos_objects_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
true adds recordCount (the number of records) to each object. Counting takes longer on large workspaces. Defaults to false.
Was this page helpful?

