Asana · Schema

GoalBase

A generic Asana Resource, containing a globally unique identifier.

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name	Type	Description
gid	string	Globally unique identifier of the resource, as a string.
resource_type	string	The base type of this resource.
name	string	The name of the goal.
html_notes	string	The notes of the goal with formatting as HTML.
notes	string	Free-form textual information associated with the goal (i.e. its description).
due_on	string	The localized day on which this goal is due. This takes a date with format `YYYY-MM-DD`.
start_on	string	The day on which work for this goal begins, or null if the goal has no start date. This takes a date with `YYYY-MM-DD` format, and cannot be set unless there is an accompanying due date.
is_workspace_level	boolean	Conditional. This property is only present when the `workspace` provided is an organization. Whether the goal belongs to the `workspace` (and is listed as part of the workspace’s goals) or not. If i
liked	boolean	True if the goal is liked by the authorized user, false if not.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GoalBase",
  "title": "GoalBase",
  "description": "A generic Asana Resource, containing a globally unique identifier.",
  "type": "object",
  "properties": {
    "gid": {
      "description": "Globally unique identifier of the resource, as a string.",
      "type": "string",
      "readOnly": true,
      "example": "12345",
      "x-insert-after": false
    },
    "resource_type": {
      "description": "The base type of this resource.",
      "type": "string",
      "readOnly": true,
      "example": "goal",
      "x-insert-after": "gid"
    },
    "name": {
      "type": "string",
      "description": "The name of the goal.",
      "example": "Grow web traffic by 30%"
    },
    "html_notes": {
      "type": "string",
      "description": "The notes of the goal with formatting as HTML.",
      "example": "<body>Start building brand awareness.</body>"
    },
    "notes": {
      "type": "string",
      "description": "Free-form textual information associated with the goal (i.e. its description).",
      "example": "Start building brand awareness."
    },
    "due_on": {
      "type": "string",
      "description": "The localized day on which this goal is due. This takes a date with format `YYYY-MM-DD`.",
      "example": "2019-09-15",
      "nullable": true
    },
    "start_on": {
      "type": "string",
      "description": "The day on which work for this goal begins, or null if the goal has no start date. This takes a date with `YYYY-MM-DD` format, and cannot be set unless there is an accompanying due date.",
      "example": "2019-09-14",
      "nullable": true
    },
    "is_workspace_level": {
      "type": "boolean",
      "description": "*Conditional*. This property is only present when the `workspace` provided is an organization. Whether the goal belongs to the `workspace` (and is listed as part of the workspace\u2019s goals) or not. If it isn\u2019t a workspace-level goal, it is a team-level goal, and is associated with the goal\u2019s team.",
      "example": true
    },
    "liked": {
      "type": "boolean",
      "description": "True if the goal is liked by the authorized user, false if not.",
      "example": false
    }
  }
}