Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Goals

Create Key Result

Add a Target to a Goal.

post/v2/goal/{goal_id}/key_result

Path parameters

goal_idstring required
Example:e53a033c

900e-462d-a849-4a216b06d930 (uuid)

Request body

namestring required
ownersinteger[] required
typestring required

Target (key result) types include: number, currency, boolean, percentage, or automatic.

steps_startinteger required
steps_endinteger required
unitstring required
task_idsstring[] required

Enter an array of task IDs to link this target with one or more tasks.

list_idsstring[] required

Enter an array of List IDs to link this target with one or more Lists.

Example request

{
  "name": "New Target Name",
  "owners": [
    183
  ],
  "type": "number",
  "steps_start": 0,
  "steps_end": 10,
  "unit": "km",
  "task_ids": [],
  "list_ids": []
}

Response

Example response

{
  "key_result": {
    "id": "947d46ed-8480-49bc-8c57-e569747efe93",
    "goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
    "name": "New Key Result Name",
    "type": "number",
    "unit": "km",
    "creator": 183,
    "date_created": "1568062902048",
    "goal_pretty_id": "6",
    "percent_completed": null,
    "completed": false,
    "task_ids": [],
    "subcategory_ids": [],
    "owners": [
      {
        "id": 183,
        "username": "John Doe",
        "email": "example@email.com",
        "color": "#827718",
        "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
        "initials": "JK"
      }
    ],
    "last_action": {
      "id": "d3183d0f-5cbd-4158-b015-71465f1df269",
      "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
      "userid": 183,
      "date_modified": "1568062902048",
      "steps_taken": null,
      "note": "Created Key Result",
      "steps_before": null,
      "steps_current": null
    }
  }
}