Goal

Create a Goal

Creates a new Goal.

Required fields: title, owners, start_date, target_date

Ownership requirements:

  • Exactly one user owner is required
  • Exactly one organizational owner (team, business_unit, or organization) is required

Atomicity: The entire operation is atomic. If any part fails, the entire operation is rolled back.

Read-only properties rejected: The following will result in a 422 error if provided:

  • id: Assigned when resource is created, can't be changed
  • progress and confidence_level: Calculated from Key Results, possibly aligned Goals, not updated directly
  • cycles: Inferred from Goal's start_date and target_date
  • supported_by: Update supports on the entities that support this Goal instead
  • created_at, updated_at, workpath_url: System-managed timestamps and URLs
post/goals

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/goals
  • Auth: HTTP bearer

Request body

titlestring required

Title of the Goal.

descriptionstring nullable

Detailed description of the Goal.

draftboolean

Whether the Goal is a draft. Defaults to false.

start_datestring date required

Start date of the Goal in ISO 8601 format.

target_datestring date required

Target completion date of the Goal in ISO 8601 format.

Example request

{
  "title": "Increase customer satisfaction",
  "description": "Focus on improving NPS scores and reducing churn through better support.",
  "start_date": "2025-01-01",
  "target_date": "2025-03-31",
  "owners": {
    "users": [
      {
        "id": 1
      }
    ],
    "teams": [
      {
        "id": 1
      }
    ],
    "business_units": [
      {
        "id": 1
      }
    ],
    "organizations": [
      {
        "id": 1
      }
    ]
  },
  "labels": [
    {
      "id": 1
    }
  ],
  "supports": {
    "goals": [
      {
        "id": 1
      }
    ],
    "key_results": [
      {
        "id": 1
      }
    ],
    "initiatives": [
      {
        "id": 1
      }
    ],
    "kpis": [
      {
        "id": 1
      }
    ],
    "strategic_elements": [
      {
        "id": 1
      }
    ]
  }
}

Response

Created

idinteger required

Unique identifier for the Goal.

titlestring required

Title of the Goal.

descriptionstring nullable

Detailed description of the Goal.

draftboolean required

Whether the Goal is still being planned, typically for an upcoming cycle. Draft Goals do not count towards the progress of the Goals they support. Set to false to activate a Goal.

progressnumber required

Progress towards the Goal from 0 to 1, calculated by Workpath as the average progress of the Goal's Key Results, of the Goals supporting it, or of both, depending on the Goal's setup. Read-only.

confidence_levelinteger required

How likely the Goal is to be achieved, from 1 to 10: 1-3 off track, 4-6 at risk, 7-10 on track. Derived from the confidence levels of the Goal's Key Results (their average, unless the account is configured otherwise). Read-only.

start_datestring date required

Start date of the Goal in ISO 8601 format.

target_datestring date required

Target completion date of the Goal in ISO 8601 format.

created_atstring date-time required

Timestamp when the Goal was created in ISO 8601 format.

updated_atstring date-time required

Timestamp when the Goal was last updated in ISO 8601 format.

workpath_urlstring uri required

URL to view the Goal in the Workpath platform.

Example response

{
  "id": 42,
  "title": "Successfully implement the strategic operating model across the organization",
  "description": "Establish a consistent approach to strategy execution by rolling out OKRs company-wide, ensuring alignment from leadership priorities down to team-level goals.",
  "draft": false,
  "progress": 0.63,
  "confidence_level": 8,
  "start_date": "2026-01-01",
  "target_date": "2026-03-31",
  "created_at": "2025-12-15T10:30:00Z",
  "updated_at": "2026-01-20T14:45:00Z",
  "workpath_url": "https://acme.workpath.com/goals/42",
  "owners": {
    "teams": [
      {
        "id": 4,
        "name": "Strategy Office"
      }
    ],
    "users": [
      {
        "id": 5,
        "name": "Thomas Weber"
      }
    ]
  },
  "collaborators": {
    "teams": [
      {
        "id": 6,
        "name": "People & Culture"
      }
    ],
    "users": [
      {
        "id": 8,
        "name": "Elena Fischer"
      }
    ]
  },
  "followers": {
    "users": [
      {
        "id": 14,
        "name": "Jonas Becker"
      }
    ]
  },
  "labels": [
    {
      "id": 2,
      "title": "Strategic Initiative"
    }
  ],
  "cycles": [
    {
      "id": 9,
      "title": "Q1 2026"
    }
  ],
  "key_results": [
    {
      "id": 11,
      "title": "Strategic priorities defined and documented",
      "description": "Complete the process of defining, documenting, and communicating company-wide strategic priorities.",
      "progress": 0.5,
      "confidence_level": 9,
      "type": "milestone",
      "current_value": 1,
      "start_value": 0,
      "target_value": 2,
      "workpath_url": "https://acme.workpath.com/goals/42?openKeyResultDetailsId=11",
      "owners": {
        "users": [
          {
            "id": 5,
            "name": "Thomas Weber"
          }
        ]
      },
      "milestones": [
        {
          "done": true,
          "title": "Strategic priorities approved by leadership team"
        },
        {
          "done": false,
          "title": "Priorities communicated to all teams via town hall"
        }
      ],
      "supported_by": {
        "goals": [
          {
            "id": 63,
            "title": "Every business unit publishes its strategic priorities"
          }
        ]
      }
    },
    {
      "id": 12,
      "title": "Teams have drafted their quarterly goals",
      "description": "Track how many teams have created and published their Q1 goals in Workpath.",
      "progress": 0.72,
      "confidence_level": 8,
      "type": "numeric",
      "current_value": 18,
      "start_value": 0,
      "target_value": 25,
      "workpath_url": "https://acme.workpath.com/goals/42?openKeyResultDetailsId=12",
      "owners": {
        "users": [
          {
            "id": 3,
            "name": "Maria Schmidt"
          }
        ]
      },
      "supported_by": {
        "initiatives": [
          {
            "id": 7,
            "title": "Roll out OKR training program to all teams"
          },
          {
            "id": 14,
            "title": "Host weekly OKR office hours for team leads"
          }
        ],
        "key_results": [
          {
            "id": 31,
            "title": "Sales teams have drafted their quarterly goals"
          },
          {
            "id": 32,
            "title": "Engineering teams have drafted their quarterly goals"
          }
        ]
      }
    },
    {
      "id": 13,
      "title": "Goals are vertically aligned to company priorities",
      "description": "Percentage of team goals that have a clear line-of-sight to strategic priorities.",
      "progress": 0.68,
      "confidence_level": 7,
      "type": "percental",
      "current_value": 68,
      "start_value": 0,
      "target_value": 100,
      "workpath_url": "https://acme.workpath.com/goals/42?openKeyResultDetailsId=13",
      "owners": {
        "teams": [
          {
            "id": 4,
            "name": "Strategy Office"
          }
        ]
      },
      "supported_by": {
        "initiatives": [
          {
            "id": 9,
            "title": "Conduct quarterly alignment reviews across all teams"
          }
        ]
      }
    },
    {
      "id": 14,
      "title": "Training budget invested in OKR enablement",
      "description": "Investment in coaching, workshops, and tooling to support the operating model rollout.",
      "progress": 0.65,
      "confidence_level": 7,
      "type": "monetary",
      "current_value": 32500,
      "start_value": 0,
      "target_value": 50000,
      "workpath_url": "https://acme.workpath.com/goals/42?openKeyResultDetailsId=14",
      "owners": {
        "teams": [
          {
            "id": 6,
            "name": "People & Culture"
          }
        ]
      },
      "currency": "EUR",
      "supported_by": {
        "initiatives": [
          {
            "id": 15,
            "title": "OKR coaching certification program"
          }
        ]
      }
    }
  ],
  "supports": {
    "goals": [
      {
        "id": 100,
        "title": "Become a strategy-led organization with clear priorities and measurable outcomes"
      }
    ],
    "kpis": [
      {
        "id": 15,
        "title": "Time to Market for Strategic Initiatives"
      }
    ]
  },
  "supported_by": {
    "initiatives": [
      {
        "id": 7,
        "title": "Roll out OKR training program to all teams"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.