Back to AsanaCreate A Subtask
Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask.
Input
type: object
properties:
parameters:
type: object
properties:
task_gid:
type: string
description: The task to operate on.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- task_gid
title: Parameters
data:
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the task.
type: string
example: Bug Task
resource_subtype:
type: string
description: >-
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.
enum:
- default_task
- milestone
- section
- approval
example: default_task
approval_status:
type: string
description: >-
*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`.
enum:
- pending
- approved
- rejected
- changes_requested
example: pending
assignee_status:
description: >-
*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.
type: string
enum:
- today
- upcoming
- later
- new
- inbox
example: upcoming
completed:
description: True if the task is currently marked complete, false if not.
type: boolean
example: false
completed_at:
description: >-
The time at which this task was completed, or null if the task is
incomplete.
type: string
format: date-time
readOnly: true
nullable: true
example: '2012-02-22T02:06:58.147Z'
completed_by:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
created_at:
description: The time at which this resource was created.
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
dependencies:
description: >-
[Opt In](/docs/inputoutput-options). Array of resources
referencing tasks that this task depends on. The objects contain
only the gid of the dependency.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
dependents:
description: >-
[Opt In](/docs/inputoutput-options). Array of resources
referencing tasks that depend on this task. The objects contain
only the ID of the dependent.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
due_at:
description: >-
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`.
type: string
format: date
example: '2019-09-15T02:06:58.147Z'
nullable: true
due_on:
description: >-
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`.
type: string
format: date
example: '2019-09-15T00:00:00.000Z'
nullable: true
external:
type: object
properties:
gid:
type: string
data:
type: string
html_notes:
description: >-
[Opt In](/docs/inputoutput-options). The notes of the text with
formatting as HTML.
type: string
example: >-
<body>Mittens <em>really</em> likes the stuff from
Humboldt.</body>
hearted:
description: >-
*Deprecated - please use liked instead* True if the task is
hearted by the authorized user, false if not.
type: boolean
example: true
readOnly: true
hearts:
description: >-
*Deprecated - please use likes instead* Array of likes for users
who have hearted this task.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The
user’s name.
example: Greg Sanchez
is_rendered_as_separator:
description: >-
[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`.
type: boolean
example: false
readOnly: true
liked:
description: True if the task is liked by the authorized user, false if not.
type: boolean
example: true
likes:
description: Array of likes for users who have liked this task.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The
user’s name.
example: Greg Sanchez
memberships:
description: >-
*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.
type: array
readOnly: true
items:
type: object
properties:
project:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
Name of the project. This is generally a short sentence
fragment that fits on a line in the UI for maximum
readability. However, it can be longer.
type: string
example: Stuff to buy
section:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
The name of the section (i.e. the text displayed as the
section header).
type: string
example: Next Actions
modified_at:
description: |-
The time at which this task was last modified.
*Note: This does not currently reflect any changes in
associations such as projects or comments that may have been
added or removed from the task.*
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
notes:
description: >-
Free-form textual information associated with the task (i.e. its
description).
type: string
example: Mittens really likes the stuff from Humboldt.
num_hearts:
description: >-
*Deprecated - please use likes instead* The number of users who
have hearted this task.
type: integer
example: 5
readOnly: true
num_likes:
description: The number of users who have liked this task.
type: integer
example: 5
readOnly: true
num_subtasks:
description: >
[Opt In](/docs/inputoutput-options). The number of subtasks on
this task.
type: integer
example: 3
readOnly: true
start_at:
description: >-
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.*
type: string
nullable: true
format: date
example: '2019-09-14T02:06:58.147Z'
start_on:
description: >-
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.*
type: string
nullable: true
format: date
example: '2019-09-14T00:00:00.000Z'
actual_time_minutes:
description: >-
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.
type: number
example: 200
readOnly: true
nullable: true
assignee:
type: string
readOnly: false
x-env-variable: true
description: Gid of a user.
example: '12345'
nullable: true
assignee_section:
nullable: true
type: string
description: >-
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.
example: '12345'
custom_fields:
type: object
properties:
'5678904321':
type: string
'4578152156':
type: string
followers:
type: array
items:
type: string
parent:
type: string
readOnly: false
x-env-variable: true
description: Gid of a task.
example: '12345'
nullable: true
projects:
type: array
items:
type: string
tags:
type: array
items:
type: string
workspace:
type: string
readOnly: false
x-env-variable: true
description: Gid of a workspace.
example: '12345'
title: Data
Output
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the task.
type: string
example: Bug Task
resource_subtype:
type: string
description: >-
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.
enum:
- default_task
- milestone
- section
- approval
example: default_task
approval_status:
type: string
description: >-
*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`.
enum:
- pending
- approved
- rejected
- changes_requested
example: pending
assignee_status:
description: >-
*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.
type: string
enum:
- today
- upcoming
- later
- new
- inbox
example: upcoming
completed:
description: True if the task is currently marked complete, false if not.
type: boolean
example: false
completed_at:
description: >-
The time at which this task was completed, or null if the task is
incomplete.
type: string
format: date-time
readOnly: true
nullable: true
example: '2012-02-22T02:06:58.147Z'
completed_by:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
created_at:
description: The time at which this resource was created.
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
dependencies:
description: >-
[Opt In](/docs/inputoutput-options). Array of resources referencing
tasks that this task depends on. The objects contain only the gid of
the dependency.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
dependents:
description: >-
[Opt In](/docs/inputoutput-options). Array of resources referencing
tasks that depend on this task. The objects contain only the ID of the
dependent.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
due_at:
description: >-
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`.
type: string
format: date
example: '2019-09-15T02:06:58.147Z'
nullable: true
due_on:
description: >-
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`.
type: string
format: date
example: '2019-09-15T00:00:00.000Z'
nullable: true
external:
type: object
properties:
gid:
type: string
data:
type: string
html_notes:
description: >-
[Opt In](/docs/inputoutput-options). The notes of the text with
formatting as HTML.
type: string
example: <body>Mittens <em>really</em> likes the stuff from Humboldt.</body>
hearted:
description: >-
*Deprecated - please use liked instead* True if the task is hearted by
the authorized user, false if not.
type: boolean
example: true
readOnly: true
hearts:
description: >-
*Deprecated - please use likes instead* Array of likes for users who
have hearted this task.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
is_rendered_as_separator:
description: >-
[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`.
type: boolean
example: false
readOnly: true
liked:
description: True if the task is liked by the authorized user, false if not.
type: boolean
example: true
likes:
description: Array of likes for users who have liked this task.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the object, as a string.
type: string
readOnly: true
example: '12345'
user:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
memberships:
description: >-
*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.
type: array
readOnly: true
items:
type: object
properties:
project:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
Name of the project. This is generally a short sentence
fragment that fits on a line in the UI for maximum
readability. However, it can be longer.
type: string
example: Stuff to buy
section:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
The name of the section (i.e. the text displayed as the
section header).
type: string
example: Next Actions
modified_at:
description: |-
The time at which this task was last modified.
*Note: This does not currently reflect any changes in
associations such as projects or comments that may have been
added or removed from the task.*
type: string
format: date-time
readOnly: true
example: '2012-02-22T02:06:58.147Z'
notes:
description: >-
Free-form textual information associated with the task (i.e. its
description).
type: string
example: Mittens really likes the stuff from Humboldt.
num_hearts:
description: >-
*Deprecated - please use likes instead* The number of users who have
hearted this task.
type: integer
example: 5
readOnly: true
num_likes:
description: The number of users who have liked this task.
type: integer
example: 5
readOnly: true
num_subtasks:
description: >
[Opt In](/docs/inputoutput-options). The number of subtasks on this
task.
type: integer
example: 3
readOnly: true
start_at:
description: >-
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.*
type: string
nullable: true
format: date
example: '2019-09-14T02:06:58.147Z'
start_on:
description: >-
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.*
type: string
nullable: true
format: date
example: '2019-09-14T00:00:00.000Z'
actual_time_minutes:
description: >-
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.
type: number
example: 200
readOnly: true
nullable: true
assignee:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
assignee_section:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
The name of the section (i.e. the text displayed as the section
header).
type: string
example: Next Actions
custom_fields:
description: >-
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.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the custom field.
type: string
example: Status
resource_subtype:
description: |
The type of the custom field. Must be one of the given values.
type: string
example: text
enum:
- text
- enum
- multi_enum
- number
- date
- people
type:
description: >
*Deprecated: new integrations should prefer the resource_subtype
field.* The type of the custom field. Must be one of the given
values.
type: string
readOnly: true
enum:
- text
- enum
- multi_enum
- number
enum_options:
description: >-
*Conditional*. Only relevant for custom fields of type `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).
type: array
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the enum option.
type: string
example: Low
enabled:
description: >-
Whether or not the enum option is a selectable value for
the custom field.
type: boolean
example: true
color:
description: The color of the enum option. Defaults to ‘none’.
type: string
example: blue
enabled:
description: '*Conditional*. Determines if the custom field is enabled or not.'
type: boolean
example: true
date_value:
type: object
properties:
date:
type: string
description: A string representing the date in YYYY-MM-DD format.
example: '2024-08-23T00:00:00.000Z'
date_time:
type: string
description: >-
A string representing the date in ISO 8601 format. If no
time value is selected, the value of `date-time` will be
`null`.
example: '2024-08-23T22:00:00.000Z'
enum_value:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the enum option.
type: string
example: Low
enabled:
description: >-
Whether or not the enum option is a selectable value for the
custom field.
type: boolean
example: true
color:
description: The color of the enum option. Defaults to ‘none’.
type: string
example: blue
multi_enum_values:
description: >-
*Conditional*. Only relevant for custom fields of type
`multi_enum`. This object is the chosen values of a `multi_enum`
custom field.
type: array
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the enum option.
type: string
example: Low
enabled:
description: >-
Whether or not the enum option is a selectable value for
the custom field.
type: boolean
example: true
color:
description: The color of the enum option. Defaults to ‘none’.
type: string
example: blue
number_value:
description: >-
*Conditional*. This number is the value of a `number` custom
field.
type: number
example: 5.2
text_value:
description: >-
*Conditional*. This string is the value of a `text` custom
field.
type: string
example: Some Value
display_value:
description: >-
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.
type: string
readOnly: true
example: blue
nullable: true
description:
description: >-
[Opt In](/docs/inputoutput-options). The description of the
custom field.
type: string
example: Development team priority
precision:
description: >-
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.
type: integer
example: 2
format:
description: The format of this custom field.
type: string
enum:
- currency
- identifier
- percentage
- custom
- none
example: custom
currency_code:
description: >-
ISO 4217 currency code to format this custom field. This will be
null if the `format` is not `currency`.
type: string
nullable: true
example: EUR
custom_label:
description: >-
This is the string that appears next to the custom field value.
This will be null if the `format` is not `custom`.
type: string
nullable: true
example: gold pieces
custom_label_position:
description: >-
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`.
type: string
enum:
- prefix
- suffix
example: suffix
is_global_to_workspace:
description: >-
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.
type: boolean
example: true
readOnly: true
has_notifications_enabled:
description: >-
*Conditional*. This flag describes whether a follower of a task
with this field should receive inbox notifications from changes
to this field.
type: boolean
example: true
asana_created_field:
description: >-
*Conditional*. A unique identifier to associate this field with
the template source of truth.
type: string
readOnly: true
nullable: true
enum:
- 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
example: priority
created_by:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
people_value:
description: >-
*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.
type: array
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: >-
*Read-only except when same user as requester*. The user’s
name.
example: Greg Sanchez
followers:
description: Array of users following this task.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
parent:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the task.
type: string
example: Bug Task
resource_subtype:
type: string
description: >-
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.
enum:
- default_task
- milestone
- section
- approval
example: default_task
projects:
description: >-
*Create-only.* Array of projects this task is 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.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: >-
Name of the project. This is generally a short sentence fragment
that fits on a line in the UI for maximum readability. However,
it can be longer.
type: string
example: Stuff to buy
tags:
type: array
items:
type: object
properties:
gid:
type: string
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
workspace:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the workspace.
type: string
example: My Company Workspace
permalink_url:
type: string
readOnly: true
description: A url that points directly to the object within Asana.
example: https://app.asana.com/0/resource/123456789/list