clickup · Schema

Goal

A Goal object representing an objective with trackable key results.

Properties

Name	Type	Description
id	string	The unique identifier of the Goal.
name	string	The name of the Goal.
team_id	string	The Workspace ID.
date_created	string	Unix timestamp when the Goal was created.
start_date	string	Unix timestamp for the Goal start date.
due_date	string	Unix timestamp for the Goal due date.
description	string	The description of the Goal.
private	boolean	Whether the Goal is private.
archived	boolean	Whether the Goal is archived.
creator	integer	The user ID of the Goal creator.
color	string	The hex color code of the Goal.
pretty_id	string	The human-readable ID of the Goal.
multiple_owners	boolean	Whether the Goal has multiple owners.
folder_id	string	The Goal Folder ID, if the Goal is in a folder.
members	array	Members associated with the Goal.
owners	array	Owners of the Goal.
key_results	array	Key Results (targets) associated with the Goal.
percent_completed	integer	The overall completion percentage of the Goal.
history	array	History of changes to the Goal.
pretty_url	string	The URL to the Goal in the ClickUp web application.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Goal",
  "title": "Goal",
  "type": "object",
  "description": "A Goal object representing an objective with trackable key results.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the Goal."
    },
    "name": {
      "type": "string",
      "description": "The name of the Goal."
    },
    "team_id": {
      "type": "string",
      "description": "The Workspace ID."
    },
    "date_created": {
      "type": "string",
      "description": "Unix timestamp when the Goal was created."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "description": "Unix timestamp for the Goal start date."
    },
    "due_date": {
      "type": "string",
      "description": "Unix timestamp for the Goal due date."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "The description of the Goal."
    },
    "private": {
      "type": "boolean",
      "description": "Whether the Goal is private."
    },
    "archived": {
      "type": "boolean",
      "description": "Whether the Goal is archived."
    },
    "creator": {
      "type": "integer",
      "description": "The user ID of the Goal creator."
    },
    "color": {
      "type": "string",
      "description": "The hex color code of the Goal."
    },
    "pretty_id": {
      "type": "string",
      "description": "The human-readable ID of the Goal."
    },
    "multiple_owners": {
      "type": "boolean",
      "description": "Whether the Goal has multiple owners."
    },
    "folder_id": {
      "type": "string",
      "nullable": true,
      "description": "The Goal Folder ID, if the Goal is in a folder."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Members associated with the Goal."
    },
    "owners": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Owners of the Goal."
    },
    "key_results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/KeyResult"
      },
      "description": "Key Results (targets) associated with the Goal."
    },
    "percent_completed": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100,
      "description": "The overall completion percentage of the Goal."
    },
    "history": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "History of changes to the Goal."
    },
    "pretty_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL to the Goal in the ClickUp web application."
    }
  }
}