Skip to content
Get started

Get an objective task by ID

$ cadenya objectives:tasks retrieve
GET/v1/objectives/{objectiveId}/tasks/{id}

Retrieves a task by ID from an objective

ParametersExpand Collapse
--objective-id: string

The ID of the objective. Supports "external_id:" prefix for external IDs.

--id: string

Task ID

ReturnsExpand Collapse
objective_task: object { data, metadata }

ObjectiveTask represents a task within an objective, typically created and managed by an AI agent to track progress toward completing the objective.

data: object { completed, number, task, completedAt }
completed: boolean

Whether the task has been completed

number: number

The sequential number of this task within the objective (auto-assigned, 1-based)

task: string

Description of the task to be completed

completedAt: optional string

Timestamp when the task was marked as completed

metadata: object { id, name }

BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves.

id: optional string
name: optional string

Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks).

Get an objective task by ID

cadenya objectives:tasks retrieve \
  --api-key 'My API Key' \
  --objective-id objectiveId \
  --id id
{
  "data": {
    "completed": true,
    "number": 0,
    "task": "task",
    "completedAt": "2019-12-27T18:11:19.117Z"
  },
  "metadata": {
    "id": "id",
    "name": "name"
  }
}
Returns Examples
{
  "data": {
    "completed": true,
    "number": 0,
    "task": "task",
    "completedAt": "2019-12-27T18:11:19.117Z"
  },
  "metadata": {
    "id": "id",
    "name": "name"
  }
}