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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
project | string | Required within parent | The project to add the task to. |
insert_after | JSON | Optional | |
insert_after (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
insert_before | JSON | Optional | |
insert_before (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
section | JSON | Optional | |
section (anyOf 1) | string | Alternative | A 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) | null | Alternative |
Add a tag to a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tag | string | Required within parent | The tag's gid to add to the task. |
Add followers to a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
followers | array | Required within parent | An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. |
followers[] | string | Each item |
Create a task — request body — body
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_status | string | Optional | *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_status | string | Optional | *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_by | JSON | Optional | |
assigned_by (anyOf 1) | JSON | Alternative | |
assigned_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
assigned_by (anyOf 1) (allOf 2) | JSON | All variants apply | 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 |
assigned_by (anyOf 2) | null | Alternative | |
completed | boolean | Optional | True if the task is currently marked complete, false if not. |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | The time at which this task was completed, or null if the task is incomplete. Format: date-time Read only: true |
completed_at (anyOf 2) | null | Alternative | |
completed_by | JSON | Optional | |
completed_by (anyOf 1) | JSON | Alternative | |
completed_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
completed_by (anyOf 1) (allOf 2) | JSON | All variants apply | Read only: true |
completed_by (anyOf 2) | null | Alternative | |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
dependencies | array | Optional | [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[] | Model | Each item | Expand 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 |
dependents | array | Optional | [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[] | Model | Each item | Expand 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_at | JSON | Optional | |
due_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
due_on | JSON | Optional | |
due_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
external | Model | Optional | Expand Get a task — response body — data data external |
html_notes | string | Optional | [Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text). |
hearted | boolean | Optional | *Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not. Read only: true |
hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this task. Read only: true |
hearts[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
has_subtasks_date_mismatch | boolean | Optional | [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_separator | boolean | Optional | [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 |
liked | boolean | Optional | True if the task is liked by the authorized user, false if not. |
likes | array | Optional | Array of likes for users who have liked this task. Read only: true |
likes[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
memberships | array | Optional | Create-only project and section membership IDs. |
memberships[] | object | Each item | |
memberships[].project | string | Required within parent | |
memberships[].section | JSON | Optional | |
memberships[].section (anyOf 1) | string | Alternative | |
memberships[].section (anyOf 2) | null | Alternative | |
modified_at | string | Optional | The 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 |
name | string | Optional | Name 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. |
notes | string | Optional | Free-form textual information associated with the task (i.e. its description). |
num_hearts | integer | Optional | *Deprecated - please use likes instead* The number of users who have hearted this task. Read only: true |
num_likes | integer | Optional | The number of users who have liked this task. Read only: true |
num_subtasks | integer | Optional | [Opt In](/docs/inputoutput-options). The number of subtasks on this task. Read only: true |
start_at | JSON | Optional | |
start_at (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
start_on | JSON | Optional | |
start_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
actual_time_minutes | JSON | Optional | |
actual_time_minutes (anyOf 1) | number | Alternative | <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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The *task* is the basic object around which many operations in Asana are centered. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the task. |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_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_by | object | Optional | [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.gid | string | Optional | Globally unique identifier of the resource. |
created_by.resource_type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assignee | JSON | Optional | |
assignee (anyOf 1) | string | Alternative | A 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) | null | Alternative | |
assignee_section | JSON | Optional | |
assignee_section (anyOf 1) | string | Alternative | 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. |
assignee_section (anyOf 2) | null | Alternative | |
custom_fields | object | Optional | An 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.* | JSON | Additional keys | |
custom_fields.* (anyOf 1) | JSON | Alternative | "{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) | string | Alternative | |
custom_fields.* (anyOf 1) (anyOf 2) | number | Alternative | |
custom_fields.* (anyOf 1) (anyOf 3) | object | Alternative | |
custom_fields.* (anyOf 1) (anyOf 4) | array | Alternative | |
custom_fields.* (anyOf 1) (anyOf 4)[] | string | Each item | |
custom_fields.* (anyOf 2) | null | Alternative | |
custom_type | JSON | Optional | |
custom_type (anyOf 1) | string | Alternative | *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) | null | Alternative | |
custom_type_status_option | JSON | Optional | |
custom_type_status_option (anyOf 1) | string | Alternative | *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) | null | Alternative | |
html_custom_fields | object | Optional | An 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.* | string | Additional keys | "{custom_field_gid}" => HTML string (e.g., "<body>Text content</body>") |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | Gid of a task. Read only: false |
parent (anyOf 2) | null | Alternative |
Create a task — request body — body data followers, projects, tags, workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
followers | array | Optional | *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[] | string | Each item | A string identifying a user. This can either be the string "me", an email, or the gid of a user. |
projects | array | Optional | *Create-Only* Array of project gids. In order to change projects on an existing task use `addProject` and `removeProject`. |
projects[] | string | Each item | Gid of a project. |
tags | array | Optional | *Create-Only* Array of tag gids. In order to change tags on an existing task use `addTag` and `removeTag`. |
tags[] | string | Each item | Gid of a tag. |
workspace | string | Optional | Gid of a workspace. Read only: false |
Duplicate a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the new task. |
include | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Search tasks in a workspace — response body — data data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).approval_status | string | Optional | *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_status | string | Optional | *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_by | JSON | Optional | |
$ (allOf 2).assigned_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).assigned_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).assigned_by (anyOf 1) (allOf 2) | JSON | All variants apply | 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 |
$ (allOf 2).assigned_by (anyOf 2) | null | Alternative | |
$ (allOf 2).completed | boolean | Optional | True if the task is currently marked complete, false if not. |
$ (allOf 2).completed_at | JSON | Optional | |
$ (allOf 2).completed_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).completed_by | JSON | Optional | |
$ (allOf 2).completed_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).completed_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).completed_by (anyOf 1) (allOf 2) | JSON | All variants apply | Read only: true |
$ (allOf 2).completed_by (anyOf 2) | null | Alternative | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).dependencies | array | Optional | [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[] | Model | Each item | Expand 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).dependents | array | Optional | [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[] | Model | Each item | Expand 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_at | JSON | Optional | |
$ (allOf 2).due_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).due_on | JSON | Optional | |
$ (allOf 2).due_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).external | Model | Optional | Expand Get a task — response body — data data external |
$ (allOf 2).html_notes | string | Optional | [Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text). |
$ (allOf 2).hearted | boolean | Optional | *Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not. Read only: true |
$ (allOf 2).hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this task. Read only: true |
$ (allOf 2).hearts[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).has_subtasks_date_mismatch | boolean | Optional | [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_separator | boolean | Optional | [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).liked | boolean | Optional | True if the task is liked by the authorized user, false if not. |
$ (allOf 2).likes | array | Optional | Array of likes for users who have liked this task. Read only: true |
$ (allOf 2).likes[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).memberships | array | Optional | <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[] | Model | Each item | Expand 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_at | string | Optional | The 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).name | string | Optional | Name 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).notes | string | Optional | Free-form textual information associated with the task (i.e. its description). |
$ (allOf 2).num_hearts | JSON | Optional | |
$ (allOf 2).num_hearts (anyOf 1) | integer | Alternative | *Deprecated - please use likes instead* The number of users who have hearted this task. Read only: true |
$ (allOf 2).num_hearts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).num_likes | JSON | Optional | |
$ (allOf 2).num_likes (anyOf 1) | integer | Alternative | The number of users who have liked this task. Read only: true |
$ (allOf 2).num_likes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).num_subtasks | JSON | Optional | |
$ (allOf 2).num_subtasks (anyOf 1) | integer | Alternative | [Opt In](/docs/inputoutput-options). The number of subtasks on this task. Read only: true |
$ (allOf 2).num_subtasks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).start_at | JSON | Optional | |
$ (allOf 2).start_at (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
$ (allOf 2).start_on | JSON | Optional | |
$ (allOf 2).start_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).actual_time_minutes | JSON | Optional | |
$ (allOf 2).actual_time_minutes (anyOf 1) | JSON | Alternative | |
$ (allOf 2).actual_time_minutes (anyOf 1) (anyOf 1) | number | Alternative | <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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).actual_time_minutes (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
Get a task — response body — data data assigned by gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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 |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | A task's project membership, indicating whether the membership is direct or inherited from an ancestor task. |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).is_inherited | boolean | Optional | Whether this membership is inherited from an ancestor task (`true`) or is a direct membership (`false`). |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
project | Model | Optional | Expand Search projects in a workspace — response body — data data item |
section | JSON | Optional | |
section (anyOf 1) | JSON | Alternative | |
section (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get sections in a project — response body — data, next page data item |
section (anyOf 1) (allOf 2) | JSON | All variants apply | |
section (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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`. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the custom field. |
type | string | Optional | *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_options | array | Optional | *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[] | Model | Each item | Expand Get a custom field — response body — data data enum options item |
enabled | boolean | Optional | *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_type | string | Optional | This 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_prefix | JSON | Optional | |
id_prefix (anyOf 1) | string | Alternative | This field is the unique custom ID string for the custom field. |
id_prefix (anyOf 2) | null | Alternative | |
input_restrictions | array | Optional | |
input_restrictions[] | string | Each 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_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a formula custom field. |
is_lookup_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a lookup custom field. |
date_value | JSON | Optional | |
date_value (anyOf 1) | Model | Alternative | Expand Get a custom field — response body — data data date value date, date time |
date_value (anyOf 2) | null | Alternative | |
enum_value | JSON | Optional | |
enum_value (anyOf 1) | Model | Alternative | Expand Get a custom field — response body — data data enum value color, enabled, gid, name, resource type |
enum_value (anyOf 2) | null | Alternative | |
multi_enum_values | array | Optional | *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[] | Model | Each item | Expand Get a custom field — response body — data data enum options item |
number_value | JSON | Optional | |
number_value (anyOf 1) | JSON | Alternative | |
number_value (anyOf 1) (anyOf 1) | number | Alternative | *Conditional*. This number is the value of a `number` custom field. |
number_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_value (anyOf 2) | null | Alternative | |
text_value | JSON | Optional | |
text_value (anyOf 1) | string | Alternative | *Conditional*. This string is the value of a `text` custom field. |
text_value (anyOf 2) | null | Alternative | |
display_value | JSON | Optional | |
display_value (anyOf 1) | string | Alternative | A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types. Read only: true |
display_value (anyOf 2) | null | Alternative | |
description | string | Optional | [Opt In](/docs/inputoutput-options). The description of the custom field. |
precision | JSON | Optional | |
precision (anyOf 1) | integer | Alternative | Only relevant for custom fields of type `Number`. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. The identifier format will always have a precision of 0. |
precision (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
format | string | Optional | The format of this custom field. Known values: currency, identifier, percentage, custom, duration, none |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | ISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`. |
currency_code (anyOf 2) | null | Alternative | |
custom_label | JSON | Optional | |
custom_label (anyOf 1) | string | Alternative | This 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) | null | Alternative | |
custom_label_position | JSON | Optional | |
custom_label_position (anyOf 1) | string | Alternative | Only relevant for custom fields with `custom` format. This depicts where to place the custom label. This will be null if the `format` is not `custom`. Known values: prefix, suffix |
custom_label_position (anyOf 2) | null | Alternative | |
is_global_to_workspace | boolean | Optional | This flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true. Read only: true |
has_notifications_enabled | boolean | Optional | *Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field. |
asana_created_field | JSON | Optional | |
asana_created_field (anyOf 1) | string | Alternative | *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) | null | Alternative | |
is_value_read_only | boolean | Optional | *Conditional*. This flag describes whether a custom field is read only. |
created_by | JSON | Optional | |
created_by (anyOf 1) | Model | Alternative | Expand Get an OOO entry — response body — data data user |
created_by (anyOf 2) | null | Alternative | |
people_value | array | Optional | *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[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
reference_value | array | Optional | *Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field. |
reference_value[] | object | Each item | A generic Asana Resource, containing a globally unique identifier. |
reference_value[].gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
reference_value[].resource_type | string | Optional | The base type of this resource. Read only: true |
reference_value[].name | string | Optional | The name of the object. |
html_text_value | JSON | Optional | |
html_text_value (anyOf 1) | string | Alternative | *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) | null | Alternative | |
privacy_setting | string | Optional | The 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_level | string | Optional | The default access level when inviting new members to the custom field. This isn't applied when the `privacy_setting` is `private`, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself. Known values: admin, editor, user |
resource_subtype | string | Optional | 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 |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | *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. |
gid | string | Optional | |
data | string | Optional |
Get a task — response body — data data memberships item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
project | Model | Optional | Expand Get a rate — response body — data data parent |
section | JSON | Optional | |
section (anyOf 1) | Model | Alternative | Expand Get a task — response body — data data memberships item section gid, name, resource type |
section (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the section (i.e. the text displayed as the section header). |
Get a task — response body — data data tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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 |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get a task — response body — data data — Task Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).assignee | JSON | Optional | |
$ (allOf 2).assignee (anyOf 1) | JSON | Alternative | |
$ (allOf 2).assignee (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).assignee (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).assignee (anyOf 2) | null | Alternative | |
$ (allOf 2).assignee_section | JSON | Optional | |
$ (allOf 2).assignee_section (anyOf 1) | JSON | Alternative | |
$ (allOf 2).assignee_section (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get sections in a project — response body — data, next page data item |
$ (allOf 2).assignee_section (anyOf 1) (allOf 2) | object | All variants apply | 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. |
$ (allOf 2).assignee_section (anyOf 2) | null | Alternative | |
$ (allOf 2).custom_fields | array | Optional | Array 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[] | Model | Each item | Expand Get a custom field — response body — data data — Custom Field Response |
$ (allOf 2).custom_type | JSON | Optional | |
$ (allOf 2).custom_type (anyOf 1) | JSON | Alternative | |
$ (allOf 2).custom_type (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a custom type — response body — data data asana created type identifier, gid, name, resource type |
$ (allOf 2).custom_type (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).custom_type (anyOf 2) | null | Alternative | |
$ (allOf 2).custom_type_status_option | JSON | Optional | |
$ (allOf 2).custom_type_status_option (anyOf 1) | JSON | Alternative | |
$ (allOf 2).custom_type_status_option (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | JSON | All variants apply | |
$ (allOf 2).custom_type_status_option (anyOf 2) | null | Alternative | |
$ (allOf 2).followers | array | Optional | Array of users following this task. Read only: true |
$ (allOf 2).followers[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).parent | JSON | Optional | |
$ (allOf 2).parent (anyOf 1) | JSON | Alternative | |
$ (allOf 2).parent (anyOf 1) (allOf 1) | Model | All variants apply | Expand Search tasks in a workspace — response body — data data item |
$ (allOf 2).parent (anyOf 1) (allOf 2) | object | All variants apply | 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 |
$ (allOf 2).parent (anyOf 2) | null | Alternative | |
$ (allOf 2).projects | array | Optional | *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[] | Model | Each item | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).effective_memberships | array | Optional | <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[] | Model | Each item | Expand 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).tags | array | Optional | Array 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[] | Model | Each item | Expand Get a task's tags — response body — data, next page data item |
$ (allOf 2).workspace | JSON | Optional | |
$ (allOf 2).workspace (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).workspace (allOf 2) | object | All 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_url | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name 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_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_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_by | object | Optional | [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.gid | string | Optional | Globally unique identifier of the resource. |
created_by.resource_type | string | Optional | The type of resource. |
approval_status | string | Optional | *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_status | string | Optional | *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_by | JSON | Optional | |
assigned_by (anyOf 1) | Model | Alternative | Expand Get a task — response body — data data assigned by gid, name, resource type |
assigned_by (anyOf 2) | null | Alternative | |
completed | boolean | Optional | True if the task is currently marked complete, false if not. |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | The time at which this task was completed, or null if the task is incomplete. Format: date-time Read only: true |
completed_at (anyOf 2) | null | Alternative | |
completed_by | JSON | Optional | |
completed_by (anyOf 1) | Model | Alternative | Expand Get a timesheet approval status — response body — data data user |
completed_by (anyOf 2) | null | Alternative | |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
dependencies | array | Optional | [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[] | object | Each item | A generic Asana Resource, containing a globally unique identifier. |
dependencies[].gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
dependencies[].resource_type | string | Optional | The base type of this resource. Read only: true |
dependents | array | Optional | [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[] | object | Each item | A generic Asana Resource, containing a globally unique identifier. |
dependents[].gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
dependents[].resource_type | string | Optional | The base type of this resource. Read only: true |
due_at | JSON | Optional | |
due_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
due_on | JSON | Optional | |
due_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
external | Model | Optional | Expand Get a task — response body — data data external |
html_notes | string | Optional | [Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text). |
hearted | boolean | Optional | *Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not. Read only: true |
hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this task. Read only: true |
hearts[] | Model | Each item | Expand Get a goal — response body — data data likes item |
has_subtasks_date_mismatch | boolean | Optional | [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_separator | boolean | Optional | [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 |
liked | boolean | Optional | True if the task is liked by the authorized user, false if not. |
likes | array | Optional | Array of likes for users who have liked this task. Read only: true |
likes[] | Model | Each item | Expand Get a goal — response body — data data likes item |
memberships | array | Optional | *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[] | Model | Each item | Expand Get a task — response body — data data memberships item |
modified_at | string | Optional | The 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 |
notes | string | Optional | Free-form textual information associated with the task (i.e. its description). |
num_hearts | JSON | Optional | |
num_hearts (anyOf 1) | integer | Alternative | *Deprecated - please use likes instead* The number of users who have hearted this task. Read only: true |
num_hearts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_likes | JSON | Optional | |
num_likes (anyOf 1) | integer | Alternative | The number of users who have liked this task. Read only: true |
num_likes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_subtasks | JSON | Optional | |
num_subtasks (anyOf 1) | integer | Alternative | [Opt In](/docs/inputoutput-options). The number of subtasks on this task. Read only: true |
num_subtasks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_at | JSON | Optional | |
start_at (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
start_on | JSON | Optional | |
start_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
actual_time_minutes | JSON | Optional | |
actual_time_minutes (anyOf 1) | JSON | Alternative | |
actual_time_minutes (anyOf 1) (anyOf 1) | number | Alternative | 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 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
actual_time_minutes (anyOf 2) | null | Alternative | |
assignee | JSON | Optional | |
assignee (anyOf 1) | Model | Alternative | Expand Get an OOO entry — response body — data data user |
assignee (anyOf 2) | null | Alternative | |
assignee_section | JSON | Optional | |
assignee_section (anyOf 1) | Model | Alternative | Expand Get a task — response body — data data assignee section gid, name, resource type |
assignee_section (anyOf 2) | null | Alternative | |
custom_fields | array | Optional | Array 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[] | Model | Each item | Expand Get a task — response body — data data custom fields item |
custom_type | JSON | Optional | |
custom_type (anyOf 1) | Model | Alternative | Expand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent |
custom_type (anyOf 2) | null | Alternative | |
custom_type_status_option | JSON | Optional | |
custom_type_status_option (anyOf 1) | object | Alternative | A generic Asana Resource, containing a globally unique identifier. |
custom_type_status_option (anyOf 1).gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
custom_type_status_option (anyOf 1).resource_type | string | Optional | The base type of this resource. Read only: true |
custom_type_status_option (anyOf 1).name | string | Optional | The name of the custom type status option. |
custom_type_status_option (anyOf 2) | null | Alternative | |
followers | array | Optional | Array of users following this task. Read only: true |
followers[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
parent | JSON | Optional | |
parent (anyOf 1) | object | Alternative | 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.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).gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
parent (anyOf 1).resource_type | string | Optional | The base type of this resource. Read only: true |
parent (anyOf 1).name | string | Optional | The name of the task. |
parent (anyOf 1).resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_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_by | object | Optional | [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.gid | string | Optional | Globally unique identifier of the resource. |
parent (anyOf 1).created_by.resource_type | string | Optional | The type of resource. |
parent (anyOf 2) | null | Alternative | |
projects | array | Optional | *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[] | Model | Each item | Expand Get a rate — response body — data data parent |
effective_memberships | array | Optional | 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 |
effective_memberships[] | JSON | Each item | A task's project membership, indicating whether the membership is direct or inherited from an ancestor task. |
effective_memberships[] (allOf 1) | Model | All variants apply | Expand Get a task — response body — data data memberships item |
effective_memberships[] (allOf 2) | object | All variants apply | |
effective_memberships[] (allOf 2).is_inherited | boolean | Optional | Whether this membership is inherited from an ancestor task (`true`) or is a direct membership (`false`). |
tags | array | Optional | Array of tags associated with this task. In order to change tags on an existing task use `addTag` and `removeTag`. Read only: true |
tags[] | Model | Each item | Expand Get a task — response body — data data tags item |
workspace | Model | Optional | Expand Get a task — response body — data data workspace |
permalink_url | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a task — response body — data data — sdk__Task Response |
next_page | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
completed_since | string | Optional | |
opt_pretty | boolean | Optional | |
limit | integer | Optional | Minimum: 1 Maximum: 100 |
offset | string | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
limit | integer | Optional | Minimum: 1 Maximum: 100 |
offset | string | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
project | string | Required within parent | The project to remove the task from. |
Remove a tag from a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tag | string | Required within parent | The tag's gid to remove from the task. |
Search tasks in a workspace — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The *task* is the basic object around which many operations in Asana are centered. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the task. |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_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_by | object | Optional | [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.gid | string | Optional | Globally unique identifier of the resource. |
created_by.resource_type | string | Optional | The type of resource. |
Set dependencies for a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | array | Optional | An array of task gids that a task depends on. |
dependencies[] | string | Each item |
Set dependents for a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A set of dependent tasks. |
dependents | array | Optional | An array of task gids that are dependents of the given task. |
dependents[] | string | Each item |
Set the parent of a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
parent | JSON | Required within parent | |
parent (anyOf 1) | string | Alternative | The new parent of the task, or `null` for no parent. |
parent (anyOf 2) | null | Alternative | |
insert_after | JSON | Optional | |
insert_after (anyOf 1) | string | Alternative | A subtask of the parent to insert the task after, or `null` to insert at the beginning of the list. |
insert_after (anyOf 2) | null | Alternative | |
insert_before | JSON | Optional | |
insert_before (anyOf 1) | string | Alternative | A subtask of the parent to insert the task before, or `null` to insert at the end of the list. |
insert_before (anyOf 2) | null | Alternative |
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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).approval_status | string | Optional | *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_status | string | Optional | *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_by | JSON | Optional | |
$ (allOf 2).assigned_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).assigned_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).assigned_by (anyOf 1) (allOf 2) | JSON | All variants apply | 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 |
$ (allOf 2).assigned_by (anyOf 2) | null | Alternative | |
$ (allOf 2).completed | boolean | Optional | True if the task is currently marked complete, false if not. |
$ (allOf 2).completed_at | JSON | Optional | |
$ (allOf 2).completed_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).completed_by | JSON | Optional | |
$ (allOf 2).completed_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).completed_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).completed_by (anyOf 1) (allOf 2) | JSON | All variants apply | Read only: true |
$ (allOf 2).completed_by (anyOf 2) | null | Alternative | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).dependencies | array | Optional | [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[] | Model | Each item | Expand 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).dependents | array | Optional | [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[] | Model | Each item | Expand 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_at | JSON | Optional | |
$ (allOf 2).due_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).due_on | JSON | Optional | |
$ (allOf 2).due_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).external | Model | Optional | Expand Get a task — response body — data data external |
$ (allOf 2).html_notes | string | Optional | [Opt In](/docs/inputoutput-options). The notes of the text with formatting as HTML. See [rich text](/docs/rich-text). |
$ (allOf 2).hearted | boolean | Optional | *Deprecated - please use liked instead* True if the task is hearted by the authorized user, false if not. Read only: true |
$ (allOf 2).hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this task. Read only: true |
$ (allOf 2).hearts[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).has_subtasks_date_mismatch | boolean | Optional | [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_separator | boolean | Optional | [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).liked | boolean | Optional | True if the task is liked by the authorized user, false if not. |
$ (allOf 2).likes | array | Optional | Array of likes for users who have liked this task. Read only: true |
$ (allOf 2).likes[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).memberships | array | Optional | <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[] | Model | Each item | Expand 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_at | string | Optional | The 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).name | string | Optional | Name 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).notes | string | Optional | Free-form textual information associated with the task (i.e. its description). |
$ (allOf 2).num_hearts | integer | Optional | *Deprecated - please use likes instead* The number of users who have hearted this task. Read only: true |
$ (allOf 2).num_likes | integer | Optional | The number of users who have liked this task. Read only: true |
$ (allOf 2).num_subtasks | integer | Optional | [Opt In](/docs/inputoutput-options). The number of subtasks on this task. Read only: true |
$ (allOf 2).start_at | JSON | Optional | |
$ (allOf 2).start_at (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
$ (allOf 2).start_on | JSON | Optional | |
$ (allOf 2).start_on (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).actual_time_minutes | JSON | Optional | |
$ (allOf 2).actual_time_minutes (anyOf 1) | number | Alternative | <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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
project | Model | Optional | Expand 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 |
section | JSON | Optional | |
section (anyOf 1) | JSON | Alternative | |
section (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get sections in a project — response body — data, next page data item |
section (anyOf 1) (allOf 2) | JSON | All variants apply | |
section (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The *task* is the basic object around which many operations in Asana are centered. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the task. |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_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_by | object | Optional | [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.gid | string | Optional | Globally unique identifier of the resource. |
created_by.resource_type | string | Optional | The type of resource. |
Update a task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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 |