Get a task
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/tasks/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/tasks/{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/tasks/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Task fetched successfully."
},
"data": {
"_id": "6728c9afb2c3d4e5f6a7b8ce",
"organizationId": "66a0f1e2d3c4b5a697887766",
"title": "Send security questionnaire to Northwind Traders",
"description": "Fill in the questionnaire Ana sent and return it by Friday.",
"status": "in_progress",
"priority": "high",
"isFinished": false,
"dueDate": "2026-11-07T17:00:00.000Z",
"assignedUser": [
{
"id": "66a0f1e2d3c4b5a697881111",
"name": "Priya Patel",
"profilePicture": null
}
],
"assignedAgents": [
{
"agentId": "66a0f1e2d3c4b5a697882222",
"name": "Account Researcher",
"role": "executor"
}
],
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"data": {
"company_name": "Northwind Traders",
"domain": "northwind.example.com"
},
"schema": {
"_id": "66a0f1e2d3c4b5a697880001",
"name": "Companies",
"objectType": "company"
}
}
],
"planCheckpoints": [
{
"id": "step-1",
"kind": "step",
"title": "Read the questionnaire",
"worker": "account_researcher",
"status": "completed"
},
{
"id": "step-2",
"kind": "step",
"title": "Draft the answers",
"worker": "account_researcher",
"status": "completed"
},
{
"id": "step-3",
"kind": "step",
"title": "Email the answers to Ana",
"worker": "email_writer",
"status": "pending"
}
],
"currentRunId": "3f9a1c2b7d4e4f0a9b8c7d6e5f4a3b2c",
"currentRun": {
"status": "awaiting_approval",
"planSteps": 3,
"completedSteps": 2,
"artifactsCount": 1,
"lastRunAt": "2026-11-04T10:20:00.000Z"
},
"artifactsCount": 1,
"agentPaused": false,
"metadata": {
"created": {
"at": "2026-11-04T09:40:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T10:20: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>"
}
}Tasks
Get a task
Returns one task with its full description, its linked records (each with the record’s field
values in data and its object in schema), its plan and the state of the workers’ current run.
GET
/
v1
/
platform
/
tasks
/
{id}
Get a task
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/tasks/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/tasks/{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/tasks/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Task fetched successfully."
},
"data": {
"_id": "6728c9afb2c3d4e5f6a7b8ce",
"organizationId": "66a0f1e2d3c4b5a697887766",
"title": "Send security questionnaire to Northwind Traders",
"description": "Fill in the questionnaire Ana sent and return it by Friday.",
"status": "in_progress",
"priority": "high",
"isFinished": false,
"dueDate": "2026-11-07T17:00:00.000Z",
"assignedUser": [
{
"id": "66a0f1e2d3c4b5a697881111",
"name": "Priya Patel",
"profilePicture": null
}
],
"assignedAgents": [
{
"agentId": "66a0f1e2d3c4b5a697882222",
"name": "Account Researcher",
"role": "executor"
}
],
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company",
"data": {
"company_name": "Northwind Traders",
"domain": "northwind.example.com"
},
"schema": {
"_id": "66a0f1e2d3c4b5a697880001",
"name": "Companies",
"objectType": "company"
}
}
],
"planCheckpoints": [
{
"id": "step-1",
"kind": "step",
"title": "Read the questionnaire",
"worker": "account_researcher",
"status": "completed"
},
{
"id": "step-2",
"kind": "step",
"title": "Draft the answers",
"worker": "account_researcher",
"status": "completed"
},
{
"id": "step-3",
"kind": "step",
"title": "Email the answers to Ana",
"worker": "email_writer",
"status": "pending"
}
],
"currentRunId": "3f9a1c2b7d4e4f0a9b8c7d6e5f4a3b2c",
"currentRun": {
"status": "awaiting_approval",
"planSteps": 3,
"completedSteps": 2,
"artifactsCount": 1,
"lastRunAt": "2026-11-04T10:20:00.000Z"
},
"artifactsCount": 1,
"agentPaused": false,
"metadata": {
"created": {
"at": "2026-11-04T09:40:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T10:20: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_tasks_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 task's id.
Pattern:
^[0-9a-fA-F]{24}$Was this page helpful?

