KeyResult

Get a Key Result of a Goal

This endpoint retrieves a specific Key Result identified by its ID within a Goal.

Type-specific fields:

  • currency is only present for Key Results of type monetary
  • milestones is only present for Key Results of type milestone

Ownership notes:

  • Key Results can be owned by one user OR one team, never both
  • Key Results cannot be directly owned by Business Units or organizations, but can belong to a Business Unit- or organization-level Goal
get/goals/{goal_id}/key_results/{key_result_id}

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/goals/{goal_id}/key_results/{key_result_id}
  • Auth: HTTP bearer

Response

OK

idinteger required

Unique identifier for the Key Result.

titlestring required

Title of the Key Result.

descriptionstring nullable required

Detailed description of the Key Result.

progressnumber required

Progress towards the Key Result, expressed as a decimal (e.g., 0.72 = 72%). Can exceed the 0-1 range when overachieving (>1) or in edge cases (<0).

confidence_levelinteger required

The owner's confidence of reaching the target in time, from 1 to 10: 1-3 off track, 4-6 at risk, 7-10 on track. Recorded with every status update.

type'numeric' | 'percental' | 'monetary' | 'milestone' | 'contributing_goal' required

How the Key Result is measured: numeric (a number, e.g. customers won), percental (a percentage), monetary (an amount in currency) or milestone (a list of milestones that are done or not). contributing_goal Key Results take their progress from a supporting Goal and cannot be created through the API.

current_valuenumber required

The latest recorded value.

start_valuenumber required

The baseline the Key Result started from.

target_valuenumber required

The value to reach by the end of the Goal.

currencystring

ISO 4217 currency code. Only present for Key Results of type monetary.

workpath_urlstring uri required

URL to view the Key Result in the Workpath platform.

Example response

{
  "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"
      }
    ]
  }
}

Changes

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