Skip to main content
The GoalTemplate interface represents a saved template that can be used to quickly create new goals with predefined structure and settings.

Properties

id
string
required
Unique identifier for the template
user_id
string
required
ID of the user who created this template
name
string
required
Name of the template for identification
structure
Partial<Goal>
required
The goal structure to use when creating a new goal from this template. This is a partial Goal object containing any subset of Goal properties to pre-fill.
created_at
string
required
ISO 8601 timestamp when the template was created

Example

{
  "id": "template_123",
  "user_id": "user_456",
  "name": "Quarterly OKR Template",
  "structure": {
    "title": "Q1 Objectives",
    "description": "Quarterly goals and key results",
    "status": "not_started",
    "is_recurring": true,
    "recurrence_cadence": "weekly",
    "priority": 5,
    "color_tag": "#4A90E2"
  },
  "created_at": "2026-01-15T08:00:00Z"
}

Type definitions

export interface GoalTemplate {
  id: string
  user_id: string
  name: string
  structure: Partial<Goal>
  created_at: string
}

Build docs developers (and LLMs) love