List record names
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas/{id}/records/lookup \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas/{id}/records/lookup', 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}/records/lookup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Object lookup fetched successfully"
},
"data": [
{
"id": "66f1a8c3e4b0a1b2c3d4e5f6",
"name": "Northwind Traders",
"imageUrl": "https://img.logo.example/northwind.example",
"isWatched": true,
"updatedAt": "2026-11-04T09:30:00.000Z"
},
{
"id": "66f1a8c3e4b0a1b2c3d4e5f7",
"name": "Contoso",
"isWatched": false,
"updatedAt": "2026-11-03T16:05:00.000Z"
}
]
}{
"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
List record names
Returns a compact index of an object’s records, for searching by name on your side: each record’s id, display name, one supporting value, image and watched state. Use it to turn a name into a record id.
The index holds up to limit records, most recently updated first. It takes no search text and has
no further pages; for older records, use List records with search.
Names and values come only from fields you may view. meta.count is the number of rows returned.
GET
/
v1
/
platform
/
base-schemas
/
{id}
/
records
/
lookup
List record names
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/base-schemas/{id}/records/lookup \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/base-schemas/{id}/records/lookup', 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}/records/lookup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Object lookup fetched successfully"
},
"data": [
{
"id": "66f1a8c3e4b0a1b2c3d4e5f6",
"name": "Northwind Traders",
"imageUrl": "https://img.logo.example/northwind.example",
"isWatched": true,
"updatedAt": "2026-11-04T09:30:00.000Z"
},
{
"id": "66f1a8c3e4b0a1b2c3d4e5f7",
"name": "Contoso",
"isWatched": false,
"updatedAt": "2026-11-03T16:05:00.000Z"
}
]
}{
"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_records_lookup.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}$Query Parameters
The most records to return, 1 to 2000. Defaults to 1000.
Required range:
1 <= x <= 2000Was this page helpful?

