GoalCompact
| Property | 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. |
owner | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
owner.gid | string | Globally unique identifier of the resource, as a string. |
owner.resource_type | string | The base type of this resource. |
owner.name | string | Read-only except when same user as requester. The user's name. |
Example JSON for GoalCompact:
{
"gid": "12345",
"resource_type": "goal",
"name": "Grow web traffic by 30%",
"owner": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
}Goal
| Property | 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 it isn’t a workspace-level goal, it is a team-level goal, and is associated with the goal’s team. |
liked | boolean | True if the goal is liked by the authorized user, false if not. |
likes[] | [object] | Array of likes for users who have liked this goal. |
likes[].gid | string | Globally unique identifier of the object, as a string. |
likes[].user | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
likes[].user.gid | string | Globally unique identifier of the resource, as a string. |
likes[].user.resource_type | string | The base type of this resource. |
likes[].user.name | string | Read-only except when same user as requester. The user's name. |
num_likes | integer | The number of users who have liked this goal. |
team | object | Conditional. This property is only present when the workspace provided is an organization. |
team.gid | string | Globally unique identifier of the resource, as a string. |
team.resource_type | string | The base type of this resource. |
team.name | string | The name of the team. |
workspace | object | A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
workspace.gid | string | Globally unique identifier of the resource, as a string. |
workspace.resource_type | string | The base type of this resource. |
workspace.name | string | The name of the workspace. |
followers[] | [object] | Array of users who are members of this goal. |
followers[].gid | string | Globally unique identifier of the resource, as a string. |
followers[].resource_type | string | The base type of this resource. |
followers[].name | string | Read-only except when same user as requester. The user's name. |
time_period | object | Full object requires scope: |
time_period.gid | string | Globally unique identifier of the resource, as a string. |
time_period.resource_type | string | The base type of this resource. |
time_period.end_on | string | The localized end date of the time period in YYYY-MM-DD format. |
time_period.start_on | string | The localized start date of the time period in YYYY-MM-DD format. |
time_period.period | string | The cadence and index of the time period. Click to show all enum values
|
time_period.display_name | string | A string representing the cadence code and the fiscal year. |
metric | object | A generic Asana Resource, containing a globally unique identifier. |
metric.gid | string | Globally unique identifier of the resource, as a string. |
metric.resource_type | string | The base type of this resource. |
metric.resource_subtype | string | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Click to show all enum values
|
metric.precision | integer | Conditional. Only relevant for goal metrics of type Number. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. |
metric.unit | string | A supported unit of measure for the goal metric, or none. Click to show all enum values
|
metric.currency_code | string | ISO 4217 currency code to format this custom field. This will be null if the unit is not currency. |
metric.initial_number_value | number | This number is the start value of a goal metric of type number. |
metric.target_number_value | number | This number is the end value of a goal metric of type number. This number cannot equal initial_number_value. |
metric.current_number_value | number | This number is the current value of a goal metric of type number. |
metric.current_display_value | string | This string is the current value of a goal metric of type string. |
metric.progress_source | string | This field defines how the progress value of a goal metric is being calculated. A goal's progress can be provided manually by the user, calculated automatically from contributing subgoals, projects, or tasks, or managed by an integration with an external data source, such as Salesforce. Click to show all enum values
|
metric.is_custom_weight | boolean | Conditional. Only relevant if metric.progress_source is one of subgoal_progress, project_task_completion, project_milestone_completion, or task_completion. If true, we use the supporting object's custom weight to calculate the goal's progress. If false, we treat all supporting objects as equally weighted |
metric.can_manage | boolean | Conditional. Only relevant for progress_source of type external. This boolean indicates whether the requester has the ability to update the current value of this metric. This returns true if the external metric was created by the requester, false otherwise. |
owner | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
owner.gid | string | Globally unique identifier of the resource, as a string. |
owner.resource_type | string | The base type of this resource. |
owner.name | string | Read-only except when same user as requester. The user's name. |
current_status_update | object | The latest status_update posted to this goal. |
current_status_update.gid | string | Globally unique identifier of the resource, as a string. |
current_status_update.resource_type | string | The base type of this resource. |
current_status_update.title | string | The title of the status update. |
current_status_update.resource_subtype | string | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_subtypes for status objects represent the type of their parent. Click to show all enum values
|
status | string | The current status of this goal. When the goal is open, its status can be green, yellow, and red to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can be missed, achieved, partial, or dropped. Note you can only write to this property if metric is set. |
custom_fields[] | [object] | Array of Custom Fields. |
custom_fields[].gid | string | Globally unique identifier of the resource, as a string. |
custom_fields[].resource_type | string | The base type of this resource. |
custom_fields[].name | string | The name of the custom field. |
custom_fields[].type | string | Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values. Click to show all enum values
|
custom_fields[].enum_options[] | [object] | Conditional. Only relevant for custom fields of type enum or multi_enum. This array specifies the possible values which an enum custom field can adopt. To modify the enum options, refer to working with enum options. |
custom_fields[].enum_options[].gid | string | Globally unique identifier of the resource, as a string. |
custom_fields[].enum_options[].resource_type | string | The base type of this resource. |
custom_fields[].enum_options[].name | string | The name of the enum option. |
custom_fields[].enum_options[].enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_fields[].enum_options[].color | string | The color of the enum option. Defaults to none. |
custom_fields[].enabled | boolean | Conditional. This field applies only to custom field values and is not available for custom field definitions. Determines if the custom field is enabled or not. For more details, see the Custom Fields documentation. |
custom_fields[].representation_type | string | This field tells the type of the custom field. Click to show all enum values
|
custom_fields[].id_prefix | string | This field is the unique custom ID string for the custom field. |
custom_fields[].input_restrictions[] | [string] | Conditional. Only relevant for custom fields of type reference. This array of strings reflects the allowed types of objects that can be written to a reference custom field value. |
custom_fields[].is_formula_field | boolean | Conditional. This flag describes whether a custom field is a formula custom field. |
custom_fields[].date_value | object | Conditional. Only relevant for custom fields of type date. This object reflects the chosen date (and optionally, time) value of a date custom field. If no date is selected, the value of date_value will be null. |
custom_fields[].date_value.date | string | A string representing the date in YYYY-MM-DD format. |
custom_fields[].date_value.date_time | string | A string representing the date in ISO 8601 format. If no time value is selected, the value of date-time will be null. |
custom_fields[].enum_value | object | Conditional. Only relevant for custom fields of type enum. This object is the chosen value of an enum custom field. |
custom_fields[].enum_value.gid | string | Globally unique identifier of the resource, as a string. |
custom_fields[].enum_value.resource_type | string | The base type of this resource. |
custom_fields[].enum_value.name | string | The name of the enum option. |
custom_fields[].enum_value.enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_fields[].enum_value.color | string | The color of the enum option. Defaults to none. |
custom_fields[].multi_enum_values[] | [object] | Conditional. Only relevant for custom fields of type multi_enum. This object is the chosen values of a multi_enum custom field. |
custom_fields[].multi_enum_values[].gid | string | Globally unique identifier of the resource, as a string. |
custom_fields[].multi_enum_values[].resource_type | string | The base type of this resource. |
custom_fields[].multi_enum_values[].name | string | The name of the enum option. |
custom_fields[].multi_enum_values[].enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_fields[].multi_enum_values[].color | string | The color of the enum option. Defaults to none. |
custom_fields[].number_value | number | Conditional. This number is the value of a number custom field. |
custom_fields[].text_value | string | Conditional. This string is the value of a text custom field. |
custom_fields[].display_value | string | A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types. |
custom_field_settings[] | [object] | Full object requires scope: |
custom_field_settings[].gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].resource_type | string | The base type of this resource. |
custom_field_settings[].project | object | Deprecated: new integrations should prefer the parent field. The id of the project that this custom field settings refers to. |
custom_field_settings[].project.gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].project.resource_type | string | The base type of this resource. |
custom_field_settings[].project.name | string | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
custom_field_settings[].is_important | boolean | is_important is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio. |
custom_field_settings[].parent | object | The parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field. |
custom_field_settings[].parent.gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].parent.resource_type | string | The base type of this resource. |
custom_field_settings[].parent.name | string | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
custom_field_settings[].custom_field | object | The custom field that is applied to the parent. |
custom_field_settings[].custom_field.gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.name | string | The name of the custom field. |
custom_field_settings[].custom_field.type | string | Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values. Click to show all enum values
|
custom_field_settings[].custom_field.enum_options[] | [object] | Conditional. Only relevant for custom fields of type enum or multi_enum. This array specifies the possible values which an enum custom field can adopt. To modify the enum options, refer to working with enum options. |
custom_field_settings[].custom_field.enum_options[].gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.enum_options[].resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.enum_options[].name | string | The name of the enum option. |
custom_field_settings[].custom_field.enum_options[].enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_field_settings[].custom_field.enum_options[].color | string | The color of the enum option. Defaults to none. |
custom_field_settings[].custom_field.enabled | boolean | Conditional. This field applies only to custom field values and is not available for custom field definitions. Determines if the custom field is enabled or not. For more details, see the Custom Fields documentation. |
custom_field_settings[].custom_field.representation_type | string | This field tells the type of the custom field. Click to show all enum values
|
custom_field_settings[].custom_field.id_prefix | string | This field is the unique custom ID string for the custom field. |
custom_field_settings[].custom_field.input_restrictions[] | [string] | Conditional. Only relevant for custom fields of type reference. This array of strings reflects the allowed types of objects that can be written to a reference custom field value. |
custom_field_settings[].custom_field.is_formula_field | boolean | Conditional. This flag describes whether a custom field is a formula custom field. |
custom_field_settings[].custom_field.date_value | object | Conditional. Only relevant for custom fields of type date. This object reflects the chosen date (and optionally, time) value of a date custom field. If no date is selected, the value of date_value will be null. |
custom_field_settings[].custom_field.date_value.date | string | A string representing the date in YYYY-MM-DD format. |
custom_field_settings[].custom_field.date_value.date_time | string | A string representing the date in ISO 8601 format. If no time value is selected, the value of date-time will be null. |
custom_field_settings[].custom_field.enum_value | object | Conditional. Only relevant for custom fields of type enum. This object is the chosen value of an enum custom field. |
custom_field_settings[].custom_field.enum_value.gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.enum_value.resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.enum_value.name | string | The name of the enum option. |
custom_field_settings[].custom_field.enum_value.enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_field_settings[].custom_field.enum_value.color | string | The color of the enum option. Defaults to none. |
custom_field_settings[].custom_field.multi_enum_values[] | [object] | Conditional. Only relevant for custom fields of type multi_enum. This object is the chosen values of a multi_enum custom field. |
custom_field_settings[].custom_field.multi_enum_values[].gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.multi_enum_values[].resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.multi_enum_values[].name | string | The name of the enum option. |
custom_field_settings[].custom_field.multi_enum_values[].enabled | boolean | Whether or not the enum option is a selectable value for the custom field. |
custom_field_settings[].custom_field.multi_enum_values[].color | string | The color of the enum option. Defaults to none. |
custom_field_settings[].custom_field.number_value | number | Conditional. This number is the value of a number custom field. |
custom_field_settings[].custom_field.text_value | string | Conditional. This string is the value of a text custom field. |
custom_field_settings[].custom_field.display_value | string | A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types. |
custom_field_settings[].custom_field.description | string | Opt In. The description of the custom field. |
custom_field_settings[].custom_field.precision | integer | Only relevant for custom fields of type Number. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. The identifier format will always have a precision of 0. |
custom_field_settings[].custom_field.format | string | The format of this custom field. Click to show all enum values
|
custom_field_settings[].custom_field.currency_code | string | ISO 4217 currency code to format this custom field. This will be null if the format is not currency. |
custom_field_settings[].custom_field.custom_label | string | This is the string that appears next to the custom field value. This will be null if the format is not custom. |
custom_field_settings[].custom_field.custom_label_position | string | Only relevant for custom fields with custom format. This depicts where to place the custom label. This will be null if the format is not custom. Click to show all enum values
|
custom_field_settings[].custom_field.is_global_to_workspace | boolean | This flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true. |
custom_field_settings[].custom_field.has_notifications_enabled | boolean | Conditional. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field. |
custom_field_settings[].custom_field.asana_created_field | string | Conditional. A unique identifier to associate this field with the template source of truth. Click to show all enum values
|
custom_field_settings[].custom_field.is_value_read_only | boolean | Conditional. This flag describes whether a custom field is read only. |
custom_field_settings[].custom_field.created_by | object | A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
custom_field_settings[].custom_field.created_by.gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.created_by.resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.created_by.name | string | Read-only except when same user as requester. The user's name. |
custom_field_settings[].custom_field.people_value[] | [object] | Conditional. Only relevant for custom fields of type people. This array of compact user objects reflects the values of a people custom field. |
custom_field_settings[].custom_field.people_value[].gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.people_value[].resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.people_value[].name | string | Read-only except when same user as requester. The user's name. |
custom_field_settings[].custom_field.reference_value[] | [object] | Conditional. Only relevant for custom fields of type reference. This array of objects reflects the values of a reference custom field. |
custom_field_settings[].custom_field.reference_value[].gid | string | Globally unique identifier of the resource, as a string. |
custom_field_settings[].custom_field.reference_value[].resource_type | string | The base type of this resource. |
custom_field_settings[].custom_field.reference_value[].name | string | The name of the object. |
custom_field_settings[].custom_field.privacy_setting | string | The privacy setting of the custom field. Note: Administrators in your organization may restrict the values of privacy_setting. Click to show all enum values
|
custom_field_settings[].custom_field.default_access_level | string | The default access level when inviting new members to the custom field. This isn't applied when the privacy_setting is private, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself. Click to show all enum values
|
custom_field_settings[].custom_field.resource_subtype | string | The type of the custom field. Must be one of the given values. Click to show all enum values
|
Example JSON for Goal:
{
"gid": "12345",
"resource_type": "goal",
"name": "Grow web traffic by 30%",
"html_notes": "<body>Start building brand awareness.</body>",
"notes": "Start building brand awareness.",
"due_on": "2019-09-15",
"start_on": "2019-09-14",
"is_workspace_level": true,
"liked": false,
"likes": [
{
"gid": "12345",
"user": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
}
],
"num_likes": 5,
"team": {
"gid": "12345",
"resource_type": "team",
"name": "Marketing"
},
"workspace": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
},
"followers": [
{
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
],
"time_period": {
"gid": "12345",
"resource_type": "time_period",
"end_on": "2019-09-14",
"start_on": "2019-09-13",
"period": "Q1",
"display_name": "Q1 FY22"
},
"metric": {
"gid": "12345",
"resource_type": "task",
"resource_subtype": "number",
"precision": 2,
"unit": "example string",
"currency_code": "EUR",
"initial_number_value": 5.2,
"target_number_value": 10.2,
"current_number_value": 8.12,
"current_display_value": "8.12",
"progress_source": "manual",
"is_custom_weight": false,
"can_manage": true
},
"owner": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"current_status_update": {
"gid": "12345",
"resource_type": "status_update",
"title": "Status Update - Jun 15",
"resource_subtype": "project_status_update"
},
"status": "green",
"custom_fields": [
{
"gid": "12345",
"resource_type": "custom_field",
"name": "Status",
"type": "example string",
"enum_options": [
{
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"enabled": true,
"representation_type": "number",
"id_prefix": "ID",
"input_restrictions": "task",
"is_formula_field": false,
"date_value": {
"date": "2024-08-23",
"date_time": "2024-08-23T22:00:00.000Z"
},
"enum_value": {
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
},
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"number_value": 5.2,
"text_value": "Some Value",
"display_value": "blue"
}
],
"custom_field_settings": [
{
"gid": "12345",
"resource_type": "custom_field_setting",
"project": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
},
"is_important": false,
"parent": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
},
"custom_field": {
"gid": "12345",
"resource_type": "custom_field",
"name": "Status",
"type": "example string",
"enum_options": [
{
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"enabled": true,
"representation_type": "number",
"id_prefix": "ID",
"input_restrictions": "task",
"is_formula_field": false,
"date_value": {
"date": "2024-08-23",
"date_time": "2024-08-23T22:00:00.000Z"
},
"enum_value": {
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
},
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "enum_option",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"number_value": 5.2,
"text_value": "Some Value",
"display_value": "blue",
"description": "Development team priority",
"precision": 2,
"format": "custom",
"currency_code": "EUR",
"custom_label": "gold pieces",
"custom_label_position": "suffix",
"is_global_to_workspace": true,
"has_notifications_enabled": true,
"asana_created_field": "priority",
"is_value_read_only": false,
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"people_value": [
{
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
],
"reference_value": [
{
"gid": "12345",
"resource_type": "task",
"name": "Bug Task"
}
],
"privacy_setting": "public_with_guests",
"default_access_level": "user",
"resource_subtype": "text"
}
}
]
}