Skip to content

Asana: Tasks schemas

40 Asana schemas with complete fields and constraints.

← Tasks operations · All schemas

Add a project to a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
projectstringRequired within parentThe project to add the task to.
insert_afterJSONOptional
insert_after (anyOf 1)stringAlternativeA task in the project to insert the task after, or `null` to insert at the beginning of the list. When used with `section`, `null` will insert at the beginning of the specified section, otherwise the task must be in the specified section.
insert_after (anyOf 2)nullAlternative
insert_beforeJSONOptional
insert_before (anyOf 1)stringAlternativeA task in the project to insert the task before, or `null` to insert at the end of the list. When used with `section`, `null` will insert at the end of the specified section, otherwise the task must be in the specified section.
insert_before (anyOf 2)nullAlternative
sectionJSONOptional
section (anyOf 1)stringAlternativeA section in the project to insert the task into. The task will be inserted at the bottom of the section unless combined with `insert_before: null` (end of section) or `insert_after: null` (beginning of section). Can also be combined with non-null `insert_before` or `insert_after` to position relative to a task within the section.
section (anyOf 2)nullAlternative

Add a tag to a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
tagstringRequired within parentThe tag's gid to add to the task.

Add followers to a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
followersarrayRequired within parentAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
followers[]stringEach item

Create a task — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONOptional
data (allOf 1)JSONAll variants apply
data (allOf 1) (allOf 1)JSONAll variants apply
data (allOf 1) (allOf 1) (allOf 1)ModelAll variants applyExpand Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom
data (allOf 1) (allOf 1) (allOf 2)ModelAll variants applyExpand Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox
data (allOf 1) (allOf 2)ModelAll variants applyExpand Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom assignee, assignee section, custom fields, custom type, custom type status option, html custom fields, parent
data (allOf 2)ModelAll variants applyExpand Create a task — request body — body data followers, projects, tags, workspace

Referenced models: Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom, Create a task — request body — body data followers, projects, tags, workspace, Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom assignee, assignee section, custom fields, custom type, custom type status option, html custom fields, parent

Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox

FieldTypePresenceDescription and constraints
$objectRoot
approval_statusstringOptional*Conditional* Reflects the approval status of this task. This field is kept in sync with `completed`, meaning `pending` translates to false while `approved`, `rejected`, and `changes_requested` translate to true. If you set completed to true, this field will be set to `approved`.
One of: pending, approved, rejected, changes_requested
assignee_statusstringOptional*Deprecated* Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.
One of: today, upcoming, later, new, inbox
assigned_byJSONOptional
assigned_by (anyOf 1)JSONAlternative
assigned_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
assigned_by (anyOf 1) (allOf 2)JSONAll variants applyThe user who assigned the task. This field is only returned when requesting it via opt_fields, and will be null if the task has no specific assigner (e.g., tasks created without an explicit assigner).
Read only: true
assigned_by (anyOf 2)nullAlternative
completedbooleanOptionalTrue if the task is currently marked complete, false if not.
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeThe time at which this task was completed, or null if the task is incomplete.
Format: date-time
Read only: true
completed_at (anyOf 2)nullAlternative
completed_byJSONOptional
completed_by (anyOf 1)JSONAlternative
completed_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
completed_by (anyOf 1) (allOf 2)JSONAll variants applyRead only: true
completed_by (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
dependenciesarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.
Read only: true
dependencies[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
dependentsarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.
Read only: true
dependents[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
due_atJSONOptional
due_at (anyOf 1)stringAlternativeThe UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`.
Format: date-time
due_at (anyOf 2)nullAlternative
due_onJSONOptional
due_on (anyOf 1)stringAlternativeThe localized date on which this task is due, or null if the task has no due date. This takes a date with `YYYY-MM-DD` format and should not be used together with `due_at`.
Format: date
due_on (anyOf 2)nullAlternative
externalModelOptionalExpand Get a task — response body — data data external
html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text).
heartedbooleanOptional*Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not.
Read only: true
heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this task.
Read only: true
hearts[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
has_subtasks_date_mismatchbooleanOptional[Opt In](/docs/inputoutput-options). True when one or more descendant subtasks have dates outside the task's own date range. This field reflects the latest computed rollup state and returns false when no rollup has been computed.
Read only: true
is_rendered_as_separatorbooleanOptional[Opt In](/docs/inputoutput-options). In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to [sections](/reference/sections) without being true `section` objects. If a `task` object is rendered this way in any context it will have the property `is_rendered_as_separator` set to `true`. This parameter only applies to regular tasks with `resource_subtype` of `default_task`. Tasks with `resource_subtype` of `milestone`, `approval`, or custom task types will not have this property and cannot be rendered as separators.
Read only: true
likedbooleanOptionalTrue if the task is liked by the authorized user, false if not.
likesarrayOptionalArray of likes for users who have liked this task.
Read only: true
likes[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
membershipsarrayOptionalCreate-only project and section membership IDs.
memberships[]objectEach item
memberships[].projectstringRequired within parent
memberships[].sectionJSONOptional
memberships[].section (anyOf 1)stringAlternative
memberships[].section (anyOf 2)nullAlternative
modified_atstringOptionalThe time at which this task was last modified.

The following conditions will change `modified_at`:

- story is created on a task
- story is trashed on a task
- attachment is trashed on a task
- task is assigned or unassigned
- custom field value is changed
- the task itself is trashed
- Or if any of the following fields are updated:
- completed
- name
- due_date
- description
- attachments
- items
- schedule_status

The following conditions will _not_ change `modified_at`:

- moving to a new container (project, portfolio, etc)
- comments being added to the task (but the stories they generate
_will_ affect `modified_at`)
Format: date-time
Read only: true
namestringOptionalName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
notesstringOptionalFree-form textual information associated with the task (i.e. its description).
num_heartsintegerOptional*Deprecated - please use likes instead* The number of users who have hearted this task.
Read only: true
num_likesintegerOptionalThe number of users who have liked this task.
Read only: true
num_subtasksintegerOptional[Opt In](/docs/inputoutput-options). The number of subtasks on this task.

Read only: true
start_atJSONOptional
start_at (anyOf 1)stringAlternativeDate and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with `start_on`.
*Note: `due_at` must be present in the request when setting or unsetting the `start_at` parameter.*
Format: date-time
start_at (anyOf 2)nullAlternative
start_onJSONOptional
start_on (anyOf 1)stringAlternativeThe day on which work begins for the task , or null if the task has no start date. This takes a date with `YYYY-MM-DD` format and should not be used together with `start_at`.
*Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter.*
Format: date
start_on (anyOf 2)nullAlternative
actual_time_minutesJSONOptional
actual_time_minutes (anyOf 1)numberAlternative<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>time_tracking_entries:read</code></p>

This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.
Read only: true
actual_time_minutes (anyOf 2)nullAlternative

Referenced models: Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item, Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item, Get users in a team — response body — data data item, Get a task — response body — data data external

Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom

FieldTypePresenceDescription and constraints
$objectRootThe *task* is the basic object around which many operations in Asana are centered.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the task.
resource_subtypestringOptionalThe 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_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date.
One of: default_task, milestone, approval, custom
created_byobjectOptional[Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
created_by.gidstringOptionalGlobally unique identifier of the resource.
created_by.resource_typestringOptionalThe type of resource.

Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom assignee, assignee section, custom fields, custom type, custom type status option, html custom fields, parent

FieldTypePresenceDescription and constraints
$objectRoot
assigneeJSONOptional
assignee (anyOf 1)stringAlternativeA string identifying a user. This can either be the string "me", an email, or the gid of a user.
Read only: false
assignee (anyOf 2)nullAlternative
assignee_sectionJSONOptional
assignee_section (anyOf 1)stringAlternativeThe *assignee section* is a subdivision of a project that groups tasks together in the assignee's "My tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My tasks."
The `assignee_section` property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to `assignee_section` with the gid of an existing section visible in the user's "My tasks" list.
assignee_section (anyOf 2)nullAlternative
custom_fieldsobjectOptionalAn object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, object, or array (depending on the custom field type). See the [custom fields guide](/docs/custom-fields-guide) for details on creating and updating custom field values.
Additional keys: see wildcard field
custom_fields.*JSONAdditional keys
custom_fields.* (anyOf 1)JSONAlternative"{custom_field_gid}" => Value (can be text, a number, etc.). For date, use format "YYYY-MM-DD" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z).
custom_fields.* (anyOf 1) (anyOf 1)stringAlternative
custom_fields.* (anyOf 1) (anyOf 2)numberAlternative
custom_fields.* (anyOf 1) (anyOf 3)objectAlternative
custom_fields.* (anyOf 1) (anyOf 4)arrayAlternative
custom_fields.* (anyOf 1) (anyOf 4)[]stringEach item
custom_fields.* (anyOf 2)nullAlternative
custom_typeJSONOptional
custom_type (anyOf 1)stringAlternative*Conditional:* You can only set custom_type if task `resource_subtype` is `custom`. GID or globally-unique identifier of a task's custom type. The type must be valid for tasks, and some Asana-created custom types cannot be assigned via the API; attempting either returns an error explaining which condition failed.
Read only: false
custom_type (anyOf 2)nullAlternative
custom_type_status_optionJSONOptional
custom_type_status_option (anyOf 1)stringAlternative*Conditional:* You can only set custom_type_status_option if task `resource_subtype` is `custom` GID or globally-unique identifier of a custom type's status option.
Read only: false
custom_type_status_option (anyOf 2)nullAlternative
html_custom_fieldsobjectOptionalAn object where each key is the GID of a text custom field and the corresponding value is a rich text HTML string. Only text-type custom fields support this parameter. Values must be wrapped in <body></body> tags. See the [custom fields guide](/docs/custom-fields-guide) and [rich text](/docs/rich-text) for details on supported formatting.
Additional keys: see wildcard field
html_custom_fields.*stringAdditional keys"{custom_field_gid}" => HTML string (e.g., "<body>Text content</body>")
parentJSONOptional
parent (anyOf 1)stringAlternativeGid of a task.
Read only: false
parent (anyOf 2)nullAlternative

Create a task — request body — body data followers, projects, tags, workspace

FieldTypePresenceDescription and constraints
$objectRoot
followersarrayOptional*Create-Only* An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. In order to change followers on an existing task use `addFollowers` and `removeFollowers`.
followers[]stringEach itemA string identifying a user. This can either be the string "me", an email, or the gid of a user.
projectsarrayOptional*Create-Only* Array of project gids. In order to change projects on an existing task use `addProject` and `removeProject`.
projects[]stringEach itemGid of a project.
tagsarrayOptional*Create-Only* Array of tag gids. In order to change tags on an existing task use `addTag` and `removeTag`.
tags[]stringEach itemGid of a tag.
workspacestringOptionalGid of a workspace.
Read only: false

Duplicate a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the new task.
includestringOptionalA comma-separated list of fields that will be duplicated to the new task.
##### Fields
- assignee
- attachments
- dates
- dependencies
- followers
- notes
- parent
- projects
- subtasks
- tags
Pattern: [notes|assignee|subtasks|attachments|tags|followers|projects|dates|dependencies|parent]

Get a task — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: actual_time_minutes, approval_status, assigned_by, assigned_by.name, assignee, assignee.name, assignee_section, assignee_section.name, assignee_status, completed, completed_at, completed_by, completed_by.name, created_at, created_by, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.default_access_level, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.html_text_value, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_lookup_field, custom_fields.is_value_read_only, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.privacy_setting, custom_fields.reference_value, custom_fields.reference_value.name, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, custom_type_status_option, custom_type_status_option.name, dependencies, dependents, due_at, due_on, effective_memberships, external, external.data, followers, followers.name, has_subtasks_date_mismatch, hearted, hearts, hearts.user, hearts.user.name, html_notes, is_rendered_as_separator, liked, likes, likes.user, likes.user.name, memberships, memberships.project, memberships.project.name, memberships.project.resource_subtype, memberships.section, memberships.section.name, modified_at, name, notes, num_hearts, num_likes, num_subtasks, parent, parent.created_by, parent.name, parent.resource_subtype, permalink_url, projects, projects.name, projects.resource_subtype, resource_subtype, start_at, start_on, tags, tags.name, workspace, workspace.name

Get a task — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a task — response body — data data — sdk__Task Response

Referenced models: Get a task — response body — data data — sdk__Task Response

Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Search tasks in a workspace — response body — data data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).approval_statusstringOptional*Conditional* Reflects the approval status of this task. This field is kept in sync with `completed`, meaning `pending` translates to false while `approved`, `rejected`, and `changes_requested` translate to true. If you set completed to true, this field will be set to `approved`.
Known values: pending, approved, rejected, changes_requested
$ (allOf 2).assignee_statusstringOptional*Deprecated* Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.
Known values: today, upcoming, later, new, inbox
$ (allOf 2).assigned_byJSONOptional
$ (allOf 2).assigned_by (anyOf 1)JSONAlternative
$ (allOf 2).assigned_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).assigned_by (anyOf 1) (allOf 2)JSONAll variants applyThe user who assigned the task. This field is only returned when requesting it via opt_fields, and will be null if the task has no specific assigner (e.g., tasks created without an explicit assigner).
Read only: true
$ (allOf 2).assigned_by (anyOf 2)nullAlternative
$ (allOf 2).completedbooleanOptionalTrue if the task is currently marked complete, false if not.
$ (allOf 2).completed_atJSONOptional
$ (allOf 2).completed_at (anyOf 1)stringAlternativeThe time at which this task was completed, or null if the task is incomplete.
Format: date-time
Read only: true
$ (allOf 2).completed_at (anyOf 2)nullAlternative
$ (allOf 2).completed_byJSONOptional
$ (allOf 2).completed_by (anyOf 1)JSONAlternative
$ (allOf 2).completed_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).completed_by (anyOf 1) (allOf 2)JSONAll variants applyRead only: true
$ (allOf 2).completed_by (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).dependenciesarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.
Read only: true
$ (allOf 2).dependencies[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
$ (allOf 2).dependentsarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.
Read only: true
$ (allOf 2).dependents[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
$ (allOf 2).due_atJSONOptional
$ (allOf 2).due_at (anyOf 1)stringAlternativeThe UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`.
Format: date-time
$ (allOf 2).due_at (anyOf 2)nullAlternative
$ (allOf 2).due_onJSONOptional
$ (allOf 2).due_on (anyOf 1)stringAlternativeThe localized date on which this task is due, or null if the task has no due date. This takes a date with `YYYY-MM-DD` format and should not be used together with `due_at`.
Format: date
$ (allOf 2).due_on (anyOf 2)nullAlternative
$ (allOf 2).externalModelOptionalExpand Get a task — response body — data data external
$ (allOf 2).html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text).
$ (allOf 2).heartedbooleanOptional*Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not.
Read only: true
$ (allOf 2).heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this task.
Read only: true
$ (allOf 2).hearts[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).has_subtasks_date_mismatchbooleanOptional[Opt In](/docs/inputoutput-options). True when one or more descendant subtasks have dates outside the task's own date range. This field reflects the latest computed rollup state and returns false when no rollup has been computed.
Read only: true
$ (allOf 2).is_rendered_as_separatorbooleanOptional[Opt In](/docs/inputoutput-options). In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to [sections](/reference/sections) without being true `section` objects. If a `task` object is rendered this way in any context it will have the property `is_rendered_as_separator` set to `true`. This parameter only applies to regular tasks with `resource_subtype` of `default_task`. Tasks with `resource_subtype` of `milestone`, `approval`, or custom task types will not have this property and cannot be rendered as separators.
Read only: true
$ (allOf 2).likedbooleanOptionalTrue if the task is liked by the authorized user, false if not.
$ (allOf 2).likesarrayOptionalArray of likes for users who have liked this task.
Read only: true
$ (allOf 2).likes[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).membershipsarrayOptional<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>projects:read</code>, <code>project_sections:read</code></p>

*Create-only*. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the `addProject` and `removeProject` endpoints. Note that over time, more types of memberships may be added to this property.
Read only: true
$ (allOf 2).memberships[]ModelEach itemExpand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item project, section
$ (allOf 2).modified_atstringOptionalThe time at which this task was last modified.

The following conditions will change `modified_at`:

- story is created on a task
- story is trashed on a task
- attachment is trashed on a task
- task is assigned or unassigned
- custom field value is changed
- the task itself is trashed
- Or if any of the following fields are updated:
- completed
- name
- due_date
- description
- attachments
- items
- schedule_status

The following conditions will _not_ change `modified_at`:

- moving to a new container (project, portfolio, etc)
- comments being added to the task (but the stories they generate
_will_ affect `modified_at`)
Format: date-time
Read only: true
$ (allOf 2).namestringOptionalName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
$ (allOf 2).notesstringOptionalFree-form textual information associated with the task (i.e. its description).
$ (allOf 2).num_heartsJSONOptional
$ (allOf 2).num_hearts (anyOf 1)integerAlternative*Deprecated - please use likes instead* The number of users who have hearted this task.
Read only: true
$ (allOf 2).num_hearts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).num_likesJSONOptional
$ (allOf 2).num_likes (anyOf 1)integerAlternativeThe number of users who have liked this task.
Read only: true
$ (allOf 2).num_likes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).num_subtasksJSONOptional
$ (allOf 2).num_subtasks (anyOf 1)integerAlternative[Opt In](/docs/inputoutput-options). The number of subtasks on this task.

Read only: true
$ (allOf 2).num_subtasks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).start_atJSONOptional
$ (allOf 2).start_at (anyOf 1)stringAlternativeDate and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with `start_on`.
*Note: `due_at` must be present in the request when setting or unsetting the `start_at` parameter.*
Format: date-time
$ (allOf 2).start_at (anyOf 2)nullAlternative
$ (allOf 2).start_onJSONOptional
$ (allOf 2).start_on (anyOf 1)stringAlternativeThe day on which work begins for the task , or null if the task has no start date. This takes a date with `YYYY-MM-DD` format and should not be used together with `start_at`.
*Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter.*
Format: date
$ (allOf 2).start_on (anyOf 2)nullAlternative
$ (allOf 2).actual_time_minutesJSONOptional
$ (allOf 2).actual_time_minutes (anyOf 1)JSONAlternative
$ (allOf 2).actual_time_minutes (anyOf 1) (anyOf 1)numberAlternative<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>time_tracking_entries:read</code></p>

This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.
Read only: true
$ (allOf 2).actual_time_minutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).actual_time_minutes (anyOf 2)nullAlternative

Referenced models: Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item, Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item, Search tasks in a workspace — response body — data data item, Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item project, section, Get users in a team — response body — data data item, Get a task — response body — data data external

Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

Get a task — response body — data data assigned by gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
The user who assigned the task. This field is only returned when requesting it via opt_fields, and will be null if the task has no specific assigner (e.g., tasks created without an explicit assigner).
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

Get a task — response body — data data assignee section gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *section* is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *section* is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project.
The *assignee section* is a subdivision of a project that groups tasks together in the assignee's "My tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My tasks."
The `assignee_section` property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to `assignee_section` with the gid of an existing section visible in the user's "My tasks" list.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the section (i.e. the text displayed as the section header).

Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p>

A generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type status option.

Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item

FieldTypePresenceDescription and constraints
$JSONRootA task's project membership, indicating whether the membership is direct or inherited from an ancestor task.
$ (allOf 1)ModelAll variants applyExpand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item project, section
$ (allOf 2)objectAll variants apply
$ (allOf 2).is_inheritedbooleanOptionalWhether this membership is inherited from an ancestor task (`true`) or is a direct membership (`false`).

Referenced models: Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item project, section

Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item project, section

FieldTypePresenceDescription and constraints
$objectRoot
projectModelOptionalExpand Search projects in a workspace — response body — data data item
sectionJSONOptional
section (anyOf 1)JSONAlternative
section (anyOf 1) (allOf 1)ModelAll variants applyExpand Get sections in a project — response body — data, next page data item
section (anyOf 1) (allOf 2)JSONAll variants apply
section (anyOf 2)nullAlternative

Referenced models: Search projects in a workspace — response body — data data item, Get sections in a project — response body — data, next page data item

Get a task — response body — data data custom fields item

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true
enum_optionsarrayOptional*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](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Get a custom field — response body — data data enum options item
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*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.
Known values: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data enum value color, enabled, gid, name, resource type
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Get a custom field — response body — data data enum options item
number_valueJSONOptional
number_value (anyOf 1)JSONAlternative
number_value (anyOf 1) (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA 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.
Read only: true
display_value (anyOf 2)nullAlternative
descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the custom field.
precisionJSONOptional
precision (anyOf 1)integerAlternativeOnly 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.
precision (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
formatstringOptionalThe format of this custom field.
Known values: currency, identifier, percentage, custom, duration, none
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`.
currency_code (anyOf 2)nullAlternative
custom_labelJSONOptional
custom_label (anyOf 1)stringAlternativeThis is the string that appears next to the custom field value. This will be null if the `format` is not `custom`.
custom_label (anyOf 2)nullAlternative
custom_label_positionJSONOptional
custom_label_position (anyOf 1)stringAlternativeOnly 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`.
Known values: prefix, suffix
custom_label_position (anyOf 2)nullAlternative
is_global_to_workspacebooleanOptionalThis flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true.
Read only: true
has_notifications_enabledbooleanOptional*Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.
asana_created_fieldJSONOptional
asana_created_field (anyOf 1)stringAlternative*Conditional*. A unique identifier to associate this field with the template source of truth.
Known values: a_v_requirements, account_name, actionable, align_shipping_link, align_status, allotted_time, appointment, approval_stage, approved, article_series, board_committee, browser, campaign_audience, campaign_project_status, campaign_regions, channel_primary, client_topic_type, complete_by, contact, contact_email_address, content_channels, content_channels_needed, content_stage, content_type, contract, contract_status, cost, creation_stage, creative_channel, creative_needed, creative_needs, data_sensitivity, deal_size, delivery_appt, delivery_appt_date, department, department_responsible, design_request_needed, design_request_type, discussion_category, do_this_task, editorial_content_status, editorial_content_tag, editorial_content_type, effort, effort_level, est_completion_date, estimated_time, estimated_value, expected_cost, external_steps_needed, favorite_idea, feedback_type, financial, funding_amount, grant_application_process, hiring_candidate_status, idea_status, ids_link, ids_patient_link, implementation_stage, insurance, interview_area, interview_question_score, itero_scan_link, job_s_applied_to, lab, launch_status, lead_status, localization_language, localization_market_team, localization_status, meeting_minutes, meeting_needed, minutes, mrr, must_localize, name_of_foundation, need_to_follow_up, next_appointment, next_steps_sales, num_people, number_of_user_reports, office_location, onboarding_activity, owner, participants_needed, patient_date_of_birth, patient_email, patient_phone, patient_status, phone_number, planning_category, point_of_contact, position, post_format, prescription, priority, priority_level, product, product_stage, progress, project_size, project_status, proposed_budget, publish_status, reason_for_scan, referral, request_type, research_status, responsible_department, responsible_team, risk_assessment_status, room_name, sales_counterpart, sentiment, shipping_link, social_channels, stage, status, status_design, status_of_initiative, system_setup, task_progress, team, team_marketing, team_responsible, time_it_takes_to_complete_tasks, timeframe, treatment_type, type_work_requests_it, use_agency, user_name, vendor_category, vendor_type, word_count
Read only: true
asana_created_field (anyOf 2)nullAlternative
is_value_read_onlybooleanOptional*Conditional*. This flag describes whether a custom field is read only.
created_byJSONOptional
created_by (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
created_by (anyOf 2)nullAlternative
people_valuearrayOptional*Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field.
people_value[]ModelEach itemExpand Get an OOO entry — response body — data data user
reference_valuearrayOptional*Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field.
reference_value[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
reference_value[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
reference_value[].resource_typestringOptionalThe base type of this resource.
Read only: true
reference_value[].namestringOptionalThe name of the object.
html_text_valueJSONOptional
html_text_value (anyOf 1)stringAlternative*Conditional*. Only relevant for custom fields of type `text`. This is the HTML representation of the text value of a custom field, corresponding to the `text_value` plain-text field. See [rich text](/docs/rich-text#reading-rich-text).
Read only: true
html_text_value (anyOf 2)nullAlternative
privacy_settingstringOptionalThe privacy setting of the custom field. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*
Known values: public_with_guests, public, private
default_access_levelstringOptionalThe 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.
Known values: admin, editor, user
resource_subtypestringOptionalThe type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true

Referenced models: Get an OOO entry — response body — data data user, Get a custom field — response body — data data date value date, date time, Get a custom field — response body — data data enum options item, Get a custom field — response body — data data enum value color, enabled, gid, name, resource type

Get a task — response body — data data external

FieldTypePresenceDescription and constraints
$objectRoot*OAuth Required*. *Conditional*. This field is returned only if external values are set or included by using [Opt In](/docs/inputoutput-options).
The external field allows you to store app-specific metadata on tasks, including a gid that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external gid is set, you can use the notation `external:custom_gid` to reference your object anywhere in the API where you may use the original object gid. See the page on Custom External Data for more details.
gidstringOptional
datastringOptional

Get a task — response body — data data memberships item

FieldTypePresenceDescription and constraints
$objectRoot
projectModelOptionalExpand Get a rate — response body — data data parent
sectionJSONOptional
section (anyOf 1)ModelAlternativeExpand Get a task — response body — data data memberships item section gid, name, resource type
section (anyOf 2)nullAlternative

Referenced models: Get a rate — response body — data data parent, Get a task — response body — data data memberships item section gid, name, resource type

Get a task — response body — data data memberships item section gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *section* is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the section (i.e. the text displayed as the section header).

Get a task — response body — data data tags item

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.

Get a task — response body — data data workspace

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
*Create-only*. The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

Get a task — response body — data data — Task Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom
$ (allOf 2)objectAll variants apply
$ (allOf 2).assigneeJSONOptional
$ (allOf 2).assignee (anyOf 1)JSONAlternative
$ (allOf 2).assignee (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).assignee (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).assignee (anyOf 2)nullAlternative
$ (allOf 2).assignee_sectionJSONOptional
$ (allOf 2).assignee_section (anyOf 1)JSONAlternative
$ (allOf 2).assignee_section (anyOf 1) (allOf 1)ModelAll variants applyExpand Get sections in a project — response body — data, next page data item
$ (allOf 2).assignee_section (anyOf 1) (allOf 2)objectAll variants applyThe *assignee section* is a subdivision of a project that groups tasks together in the assignee's "My tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My tasks."
The `assignee_section` property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to `assignee_section` with the gid of an existing section visible in the user's "My tasks" list.
$ (allOf 2).assignee_section (anyOf 2)nullAlternative
$ (allOf 2).custom_fieldsarrayOptionalArray of custom field values applied to the task. These represent the custom field values recorded on this project for a particular custom field. For example, these custom field values will contain an `enum_value` property for custom fields of type `enum`, a `text_value` property for custom fields of type `text`, and so on. Please note that the `gid` returned on each custom field value *is identical* to the `gid` of the custom field, which allows referencing the custom field metadata through the `/custom_fields/custom_field_gid` endpoint. The array includes custom fields from projects the task belongs to directly and from projects inherited from its full ancestor chain.
Read only: true
$ (allOf 2).custom_fields[]ModelEach itemExpand Get a custom field — response body — data data — Custom Field Response
$ (allOf 2).custom_typeJSONOptional
$ (allOf 2).custom_type (anyOf 1)JSONAlternative
$ (allOf 2).custom_type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
$ (allOf 2).custom_type (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).custom_type (anyOf 2)nullAlternative
$ (allOf 2).custom_type_status_optionJSONOptional
$ (allOf 2).custom_type_status_option (anyOf 1)JSONAlternative
$ (allOf 2).custom_type_status_option (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type
$ (allOf 2).custom_type_status_option (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).custom_type_status_option (anyOf 2)nullAlternative
$ (allOf 2).followersarrayOptionalArray of users following this task.
Read only: true
$ (allOf 2).followers[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (anyOf 1)JSONAlternative
$ (allOf 2).parent (anyOf 1) (allOf 1)ModelAll variants applyExpand Search tasks in a workspace — response body — data data item
$ (allOf 2).parent (anyOf 1) (allOf 2)objectAll variants applyThe parent of this task, or `null` if this is not a subtask. This property cannot be modified using a PUT request but you can change it with the `setParent` endpoint. You can create subtasks by using the subtasks endpoint.
Read only: true
$ (allOf 2).parent (anyOf 2)nullAlternative
$ (allOf 2).projectsarrayOptional*Create-only.* Array of projects this task is directly associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the addProject and removeProject endpoints.
Read only: true
$ (allOf 2).projects[]ModelEach itemExpand Search projects in a workspace — response body — data data item
$ (allOf 2).effective_membershipsarrayOptional<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>projects:read</code>, <code>project_sections:read</code></p>

Opt-in, read-only. The union of direct and inherited memberships for this task. If the task is both directly associated with and inherits the same project, the direct membership takes precedence.
Read only: true
$ (allOf 2).effective_memberships[]ModelEach itemExpand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item
$ (allOf 2).tagsarrayOptionalArray of tags associated with this task. In order to change tags on an existing task use `addTag` and `removeTag`.
Read only: true
$ (allOf 2).tags[]ModelEach itemExpand Get a task's tags — response body — data, next page data item
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply*Create-only*. The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
Read only: true
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true

Referenced models: Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type, Get a custom field — response body — data data — Custom Field Response, Get a custom type — response body — data data asana created type identifier, gid, name, resource type, Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace effective memberships item, Search projects in a workspace — response body — data data item, Get sections in a project — response body — data, next page data item, Get a task's tags — response body — data, next page data item, Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom, Search tasks in a workspace — response body — data data item, Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a task — response body — data data — sdk__Task Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
The *task* is the basic object around which many operations in Asana are centered.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe 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_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date.
Known values: default_task, milestone, approval, custom
created_byobjectOptional[Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
created_by.gidstringOptionalGlobally unique identifier of the resource.
created_by.resource_typestringOptionalThe type of resource.
approval_statusstringOptional*Conditional* Reflects the approval status of this task. This field is kept in sync with `completed`, meaning `pending` translates to false while `approved`, `rejected`, and `changes_requested` translate to true. If you set completed to true, this field will be set to `approved`.
Known values: pending, approved, rejected, changes_requested
assignee_statusstringOptional*Deprecated* Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.
Known values: today, upcoming, later, new, inbox
assigned_byJSONOptional
assigned_by (anyOf 1)ModelAlternativeExpand Get a task — response body — data data assigned by gid, name, resource type
assigned_by (anyOf 2)nullAlternative
completedbooleanOptionalTrue if the task is currently marked complete, false if not.
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeThe time at which this task was completed, or null if the task is incomplete.
Format: date-time
Read only: true
completed_at (anyOf 2)nullAlternative
completed_byJSONOptional
completed_by (anyOf 1)ModelAlternativeExpand Get a timesheet approval status — response body — data data user
completed_by (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
dependenciesarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.
Read only: true
dependencies[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
dependencies[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
dependencies[].resource_typestringOptionalThe base type of this resource.
Read only: true
dependentsarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.
Read only: true
dependents[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
dependents[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
dependents[].resource_typestringOptionalThe base type of this resource.
Read only: true
due_atJSONOptional
due_at (anyOf 1)stringAlternativeThe UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`.
Format: date-time
due_at (anyOf 2)nullAlternative
due_onJSONOptional
due_on (anyOf 1)stringAlternativeThe localized date on which this task is due, or null if the task has no due date. This takes a date with `YYYY-MM-DD` format and should not be used together with `due_at`.
Format: date
due_on (anyOf 2)nullAlternative
externalModelOptionalExpand Get a task — response body — data data external
html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text).
heartedbooleanOptional*Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not.
Read only: true
heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this task.
Read only: true
hearts[]ModelEach itemExpand Get a goal — response body — data data likes item
has_subtasks_date_mismatchbooleanOptional[Opt In](/docs/inputoutput-options). True when one or more descendant subtasks have dates outside the task's own date range. This field reflects the latest computed rollup state and returns false when no rollup has been computed.
Read only: true
is_rendered_as_separatorbooleanOptional[Opt In](/docs/inputoutput-options). In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to [sections](/reference/sections) without being true `section` objects. If a `task` object is rendered this way in any context it will have the property `is_rendered_as_separator` set to `true`. This parameter only applies to regular tasks with `resource_subtype` of `default_task`. Tasks with `resource_subtype` of `milestone`, `approval`, or custom task types will not have this property and cannot be rendered as separators.
Read only: true
likedbooleanOptionalTrue if the task is liked by the authorized user, false if not.
likesarrayOptionalArray of likes for users who have liked this task.
Read only: true
likes[]ModelEach itemExpand Get a goal — response body — data data likes item
membershipsarrayOptional*Create-only*. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the `addProject` and `removeProject` endpoints. Note that over time, more types of memberships may be added to this property.
Read only: true
memberships[]ModelEach itemExpand Get a task — response body — data data memberships item
modified_atstringOptionalThe time at which this task was last modified.

The following conditions will change `modified_at`:

- story is created on a task
- story is trashed on a task
- attachment is trashed on a task
- task is assigned or unassigned
- custom field value is changed
- the task itself is trashed
- Or if any of the following fields are updated:
- completed
- name
- due_date
- description
- attachments
- items
- schedule_status

The following conditions will _not_ change `modified_at`:

- moving to a new container (project, portfolio, etc)
- comments being added to the task (but the stories they generate
_will_ affect `modified_at`)
Format: date-time
Read only: true
notesstringOptionalFree-form textual information associated with the task (i.e. its description).
num_heartsJSONOptional
num_hearts (anyOf 1)integerAlternative*Deprecated - please use likes instead* The number of users who have hearted this task.
Read only: true
num_hearts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_likesJSONOptional
num_likes (anyOf 1)integerAlternativeThe number of users who have liked this task.
Read only: true
num_likes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_subtasksJSONOptional
num_subtasks (anyOf 1)integerAlternative[Opt In](/docs/inputoutput-options). The number of subtasks on this task.

Read only: true
num_subtasks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_atJSONOptional
start_at (anyOf 1)stringAlternativeDate and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with `start_on`.
*Note: `due_at` must be present in the request when setting or unsetting the `start_at` parameter.*
Format: date-time
start_at (anyOf 2)nullAlternative
start_onJSONOptional
start_on (anyOf 1)stringAlternativeThe day on which work begins for the task , or null if the task has no start date. This takes a date with `YYYY-MM-DD` format and should not be used together with `start_at`.
*Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter.*
Format: date
start_on (anyOf 2)nullAlternative
actual_time_minutesJSONOptional
actual_time_minutes (anyOf 1)JSONAlternative
actual_time_minutes (anyOf 1) (anyOf 1)numberAlternativeThis value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.
Read only: true
actual_time_minutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actual_time_minutes (anyOf 2)nullAlternative
assigneeJSONOptional
assignee (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
assignee (anyOf 2)nullAlternative
assignee_sectionJSONOptional
assignee_section (anyOf 1)ModelAlternativeExpand Get a task — response body — data data assignee section gid, name, resource type
assignee_section (anyOf 2)nullAlternative
custom_fieldsarrayOptionalArray of custom field values applied to the task. These represent the custom field values recorded on this project for a particular custom field. For example, these custom field values will contain an `enum_value` property for custom fields of type `enum`, a `text_value` property for custom fields of type `text`, and so on. Please note that the `gid` returned on each custom field value *is identical* to the `gid` of the custom field, which allows referencing the custom field metadata through the `/custom_fields/custom_field_gid` endpoint. The array includes custom fields from projects the task belongs to directly and from projects inherited from its full ancestor chain.
Read only: true
custom_fields[]ModelEach itemExpand Get a task — response body — data data custom fields item
custom_typeJSONOptional
custom_type (anyOf 1)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent
custom_type (anyOf 2)nullAlternative
custom_type_status_optionJSONOptional
custom_type_status_option (anyOf 1)objectAlternativeA generic Asana Resource, containing a globally unique identifier.
custom_type_status_option (anyOf 1).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
custom_type_status_option (anyOf 1).resource_typestringOptionalThe base type of this resource.
Read only: true
custom_type_status_option (anyOf 1).namestringOptionalThe name of the custom type status option.
custom_type_status_option (anyOf 2)nullAlternative
followersarrayOptionalArray of users following this task.
Read only: true
followers[]ModelEach itemExpand Get an OOO entry — response body — data data user
parentJSONOptional
parent (anyOf 1)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
The *task* is the basic object around which many operations in Asana are centered.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
The *task* is the basic object around which many operations in Asana are centered.
The parent of this task, or `null` if this is not a subtask. This property cannot be modified using a PUT request but you can change it with the `setParent` endpoint. You can create subtasks by using the subtasks endpoint.
Read only: true
parent (anyOf 1).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
parent (anyOf 1).resource_typestringOptionalThe base type of this resource.
Read only: true
parent (anyOf 1).namestringOptionalThe name of the task.
parent (anyOf 1).resource_subtypestringOptionalThe 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_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date.
Known values: default_task, milestone, approval, custom
parent (anyOf 1).created_byobjectOptional[Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
parent (anyOf 1).created_by.gidstringOptionalGlobally unique identifier of the resource.
parent (anyOf 1).created_by.resource_typestringOptionalThe type of resource.
parent (anyOf 2)nullAlternative
projectsarrayOptional*Create-only.* Array of projects this task is directly associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the addProject and removeProject endpoints.
Read only: true
projects[]ModelEach itemExpand Get a rate — response body — data data parent
effective_membershipsarrayOptionalOpt-in, read-only. The union of direct and inherited memberships for this task. If the task is both directly associated with and inherits the same project, the direct membership takes precedence.
Read only: true
effective_memberships[]JSONEach itemA task's project membership, indicating whether the membership is direct or inherited from an ancestor task.
effective_memberships[] (allOf 1)ModelAll variants applyExpand Get a task — response body — data data memberships item
effective_memberships[] (allOf 2)objectAll variants apply
effective_memberships[] (allOf 2).is_inheritedbooleanOptionalWhether this membership is inherited from an ancestor task (`true`) or is a direct membership (`false`).
tagsarrayOptionalArray of tags associated with this task. In order to change tags on an existing task use `addTag` and `removeTag`.
Read only: true
tags[]ModelEach itemExpand Get a task — response body — data data tags item
workspaceModelOptionalExpand Get a task — response body — data data workspace
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true

Referenced models: Get a task — response body — data data assigned by gid, name, resource type, Get a task — response body — data data assignee section gid, name, resource type, Get an OOO entry — response body — data data user, Get a task — response body — data data external, Get a goal — response body — data data likes item, Get a task — response body — data data memberships item, Get a task — response body — data data custom fields item, Get a rate — response body — data data parent, Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent, Get a timesheet approval status — response body — data data user, Get a task — response body — data data tags item, Get a task — response body — data data workspace

Get multiple tasks — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a task — response body — data data — sdk__Task Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a task — response body — data data — sdk__Task Response

Get tasks from a project — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
completed_sincestringOptional
opt_prettybooleanOptional
limitintegerOptionalMinimum: 1
Maximum: 100
offsetstringOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: actual_time_minutes, approval_status, assigned_by, assigned_by.name, assignee, assignee.name, assignee_section, assignee_section.name, assignee_status, completed, completed_at, completed_by, completed_by.name, created_at, created_by, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.default_access_level, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.html_text_value, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_lookup_field, custom_fields.is_value_read_only, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.privacy_setting, custom_fields.reference_value, custom_fields.reference_value.name, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, custom_type_status_option, custom_type_status_option.name, dependencies, dependents, due_at, due_on, effective_memberships, external, external.data, followers, followers.name, has_subtasks_date_mismatch, hearted, hearts, hearts.user, hearts.user.name, html_notes, is_rendered_as_separator, liked, likes, likes.user, likes.user.name, memberships, memberships.project, memberships.project.name, memberships.project.resource_subtype, memberships.section, memberships.section.name, modified_at, name, notes, num_hearts, num_likes, num_subtasks, offset, parent, parent.created_by, parent.name, parent.resource_subtype, path, permalink_url, projects, projects.name, projects.resource_subtype, resource_subtype, start_at, start_on, tags, tags.name, uri, workspace, workspace.name

Get tasks from a tag — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
limitintegerOptionalMinimum: 1
Maximum: 100
offsetstringOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: actual_time_minutes, approval_status, assigned_by, assigned_by.name, assignee, assignee.name, assignee_section, assignee_section.name, assignee_status, completed, completed_at, completed_by, completed_by.name, created_at, created_by, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.default_access_level, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.html_text_value, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_lookup_field, custom_fields.is_value_read_only, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.privacy_setting, custom_fields.reference_value, custom_fields.reference_value.name, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, custom_type_status_option, custom_type_status_option.name, dependencies, dependents, due_at, due_on, effective_memberships, external, external.data, followers, followers.name, has_subtasks_date_mismatch, hearted, hearts, hearts.user, hearts.user.name, html_notes, is_rendered_as_separator, liked, likes, likes.user, likes.user.name, memberships, memberships.project, memberships.project.name, memberships.project.resource_subtype, memberships.section, memberships.section.name, modified_at, name, notes, num_hearts, num_likes, num_subtasks, offset, parent, parent.created_by, parent.name, parent.resource_subtype, path, permalink_url, projects, projects.name, projects.resource_subtype, resource_subtype, start_at, start_on, tags, tags.name, uri, workspace, workspace.name

Remove a project from a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
projectstringRequired within parentThe project to remove the task from.

Remove a tag from a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
tagstringRequired within parentThe tag's gid to remove from the task.

Search tasks in a workspace — response body — data data item

FieldTypePresenceDescription and constraints
$objectRootThe *task* is the basic object around which many operations in Asana are centered.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the task.
resource_subtypestringOptionalThe 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_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date.
Known values: default_task, milestone, approval, custom
created_byobjectOptional[Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
created_by.gidstringOptionalGlobally unique identifier of the resource.
created_by.resource_typestringOptionalThe type of resource.

Set dependencies for a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
dependenciesarrayOptionalAn array of task gids that a task depends on.
dependencies[]stringEach item

Set dependents for a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRootA set of dependent tasks.
dependentsarrayOptionalAn array of task gids that are dependents of the given task.
dependents[]stringEach item

Set the parent of a task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
parentJSONRequired within parent
parent (anyOf 1)stringAlternativeThe new parent of the task, or `null` for no parent.
parent (anyOf 2)nullAlternative
insert_afterJSONOptional
insert_after (anyOf 1)stringAlternativeA subtask of the parent to insert the task after, or `null` to insert at the beginning of the list.
insert_after (anyOf 2)nullAlternative
insert_beforeJSONOptional
insert_before (anyOf 1)stringAlternativeA subtask of the parent to insert the task before, or `null` to insert at the end of the list.
insert_before (anyOf 2)nullAlternative

Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom
$ (allOf 2)ModelAll variants applyExpand Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom assignee, assignee section, custom fields, custom type, custom type status option, html custom fields, parent

Referenced models: Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom, Create a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom assignee, assignee section, custom fields, custom type, custom type status option, html custom fields, parent

Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom
$ (allOf 2)objectAll variants apply
$ (allOf 2).approval_statusstringOptional*Conditional* Reflects the approval status of this task. This field is kept in sync with `completed`, meaning `pending` translates to false while `approved`, `rejected`, and `changes_requested` translate to true. If you set completed to true, this field will be set to `approved`.
One of: pending, approved, rejected, changes_requested
$ (allOf 2).assignee_statusstringOptional*Deprecated* Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.
One of: today, upcoming, later, new, inbox
$ (allOf 2).assigned_byJSONOptional
$ (allOf 2).assigned_by (anyOf 1)JSONAlternative
$ (allOf 2).assigned_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).assigned_by (anyOf 1) (allOf 2)JSONAll variants applyThe user who assigned the task. This field is only returned when requesting it via opt_fields, and will be null if the task has no specific assigner (e.g., tasks created without an explicit assigner).
Read only: true
$ (allOf 2).assigned_by (anyOf 2)nullAlternative
$ (allOf 2).completedbooleanOptionalTrue if the task is currently marked complete, false if not.
$ (allOf 2).completed_atJSONOptional
$ (allOf 2).completed_at (anyOf 1)stringAlternativeThe time at which this task was completed, or null if the task is incomplete.
Format: date-time
Read only: true
$ (allOf 2).completed_at (anyOf 2)nullAlternative
$ (allOf 2).completed_byJSONOptional
$ (allOf 2).completed_by (anyOf 1)JSONAlternative
$ (allOf 2).completed_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).completed_by (anyOf 1) (allOf 2)JSONAll variants applyRead only: true
$ (allOf 2).completed_by (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).dependenciesarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.
Read only: true
$ (allOf 2).dependencies[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
$ (allOf 2).dependentsarrayOptional[Opt In](/docs/inputoutput-options). Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.
Read only: true
$ (allOf 2).dependents[]ModelEach itemExpand Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item
$ (allOf 2).due_atJSONOptional
$ (allOf 2).due_at (anyOf 1)stringAlternativeThe UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with `due_on`.
Format: date-time
$ (allOf 2).due_at (anyOf 2)nullAlternative
$ (allOf 2).due_onJSONOptional
$ (allOf 2).due_on (anyOf 1)stringAlternativeThe localized date on which this task is due, or null if the task has no due date. This takes a date with `YYYY-MM-DD` format and should not be used together with `due_at`.
Format: date
$ (allOf 2).due_on (anyOf 2)nullAlternative
$ (allOf 2).externalModelOptionalExpand Get a task — response body — data data external
$ (allOf 2).html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text).
$ (allOf 2).heartedbooleanOptional*Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not.
Read only: true
$ (allOf 2).heartsarrayOptional*Deprecated - please use likes instead* Array of likes for users who have hearted this task.
Read only: true
$ (allOf 2).hearts[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).has_subtasks_date_mismatchbooleanOptional[Opt In](/docs/inputoutput-options). True when one or more descendant subtasks have dates outside the task's own date range. This field reflects the latest computed rollup state and returns false when no rollup has been computed.
Read only: true
$ (allOf 2).is_rendered_as_separatorbooleanOptional[Opt In](/docs/inputoutput-options). In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to [sections](/reference/sections) without being true `section` objects. If a `task` object is rendered this way in any context it will have the property `is_rendered_as_separator` set to `true`. This parameter only applies to regular tasks with `resource_subtype` of `default_task`. Tasks with `resource_subtype` of `milestone`, `approval`, or custom task types will not have this property and cannot be rendered as separators.
Read only: true
$ (allOf 2).likedbooleanOptionalTrue if the task is liked by the authorized user, false if not.
$ (allOf 2).likesarrayOptionalArray of likes for users who have liked this task.
Read only: true
$ (allOf 2).likes[]ModelEach itemExpand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item
$ (allOf 2).membershipsarrayOptional<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>projects:read</code>, <code>project_sections:read</code></p>

*Create-only*. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the `addProject` and `removeProject` endpoints. Note that over time, more types of memberships may be added to this property.
Read only: true
$ (allOf 2).memberships[]ModelEach itemExpand Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox memberships item
$ (allOf 2).modified_atstringOptionalThe time at which this task was last modified.

The following conditions will change `modified_at`:

- story is created on a task
- story is trashed on a task
- attachment is trashed on a task
- task is assigned or unassigned
- custom field value is changed
- the task itself is trashed
- Or if any of the following fields are updated:
- completed
- name
- due_date
- description
- attachments
- items
- schedule_status

The following conditions will _not_ change `modified_at`:

- moving to a new container (project, portfolio, etc)
- comments being added to the task (but the stories they generate
_will_ affect `modified_at`)
Format: date-time
Read only: true
$ (allOf 2).namestringOptionalName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
$ (allOf 2).notesstringOptionalFree-form textual information associated with the task (i.e. its description).
$ (allOf 2).num_heartsintegerOptional*Deprecated - please use likes instead* The number of users who have hearted this task.
Read only: true
$ (allOf 2).num_likesintegerOptionalThe number of users who have liked this task.
Read only: true
$ (allOf 2).num_subtasksintegerOptional[Opt In](/docs/inputoutput-options). The number of subtasks on this task.

Read only: true
$ (allOf 2).start_atJSONOptional
$ (allOf 2).start_at (anyOf 1)stringAlternativeDate and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with `start_on`.
*Note: `due_at` must be present in the request when setting or unsetting the `start_at` parameter.*
Format: date-time
$ (allOf 2).start_at (anyOf 2)nullAlternative
$ (allOf 2).start_onJSONOptional
$ (allOf 2).start_on (anyOf 1)stringAlternativeThe day on which work begins for the task , or null if the task has no start date. This takes a date with `YYYY-MM-DD` format and should not be used together with `start_at`.
*Note: `due_on` or `due_at` must be present in the request when setting or unsetting the `start_on` parameter.*
Format: date
$ (allOf 2).start_on (anyOf 2)nullAlternative
$ (allOf 2).actual_time_minutesJSONOptional
$ (allOf 2).actual_time_minutes (anyOf 1)numberAlternative<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>time_tracking_entries:read</code></p>

This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.
Read only: true
$ (allOf 2).actual_time_minutes (anyOf 2)nullAlternative

Referenced models: Get a task — response body — data / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox dependents item, Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item, Get users in a team — response body — data data item, Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom, Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox memberships item, Get a task — response body — data data external

Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox memberships item

FieldTypePresenceDescription and constraints
$objectRoot
projectModelOptionalExpand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom
sectionJSONOptional
section (anyOf 1)JSONAlternative
section (anyOf 1) (allOf 1)ModelAll variants applyExpand Get sections in a project — response body — data, next page data item
section (anyOf 1) (allOf 2)JSONAll variants apply
section (anyOf 2)nullAlternative

Referenced models: Get sections in a project — response body — data, next page data item, Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom

Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom approval status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom resource subtype: default task, milestone, approval, custom

FieldTypePresenceDescription and constraints
$objectRootThe *task* is the basic object around which many operations in Asana are centered.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the task.
resource_subtypestringOptionalThe 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_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date.
One of: default_task, milestone, approval, custom
created_byobjectOptional[Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
created_by.gidstringOptionalGlobally unique identifier of the resource.
created_by.resource_typestringOptionalThe type of resource.

Update a task — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom

Referenced models: Update a task — request body — body / data / approval_status: pending, approved, rejected, changes requested, assignee status: today, upcoming, later, new, inbox, resource subtype: default task, milestone, approval, custom

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.