TaskDuplicateRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "New Task Name",
"description": "The name of the new task."
},
"include": {
"type": "string",
"example": [
"notes,assignee,subtasks,attachments,tags,followers,projects,dates,dependencies,parent"
],
"pattern": "([notes|assignee|subtasks|attachments|tags|followers|projects|dates|dependencies|parent])(,\\1)*",
"description": "A comma-separated list of fields that will be duplicated to the new task.\n##### Fields\n- assignee\n- attachments\n- dates\n- dependencies\n- followers\n- notes\n- parent\n- projects\n- subtasks\n- tags"
}
}
}
TaskRemoveFollowersRequest
{
"type": "object",
"required": [
"followers"
],
"properties": {
"followers": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"13579",
"321654"
],
"description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user."
}
}
}
TaskRemoveProjectRequest
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"example": "13579",
"description": "The project to remove the task from."
}
}
}
TaskRemoveTagRequest
{
"type": "object",
"required": [
"tag"
],
"properties": {
"tag": {
"type": "string",
"example": "13579",
"description": "The tag's gid to remove from the task."
}
}
}
TaskRequest
{
"allOf": [
{
"$ref": "#/components/schemas/TaskBase"
},
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "Gid of a tag."
},
"example": [
"12345"
],
"description": "*Create-Only* Array of tag gids. In order to change tags on an existing task use `addTag` and `removeTag`."
},
"parent": {
"type": "string",
"example": "12345",
"nullable": true,
"readOnly": false,
"description": "Gid of a task.",
"x-env-variable": true
},
"assignee": {
"type": "string",
"example": "12345",
"nullable": true,
"readOnly": false,
"description": "Gid of a user.",
"x-env-variable": true
},
"projects": {
"type": "array",
"items": {
"type": "string",
"description": "Gid of a project."
},
"example": [
"12345"
],
"description": "*Create-Only* Array of project gids. In order to change projects on an existing task use `addProject` and `removeProject`."
},
"followers": {
"type": "array",
"items": {
"type": "string",
"description": "Gid of a user."
},
"example": [
"12345"
],
"description": "*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`."
},
"workspace": {
"type": "string",
"example": "12345",
"readOnly": false,
"description": "Gid of a workspace.",
"x-env-variable": true
},
"custom_fields": {
"type": "object",
"example": {
"4578152156": "Not Started",
"5678904321": "On Hold"
},
"description": "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](https://raw.githubusercontent.com) for details on creating and updating custom field values.",
"additionalProperties": {
"type": "string",
"description": "\"{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)."
}
},
"assignee_section": {
"type": "string",
"example": "12345",
"nullable": true,
"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.\"\nThe `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."
}
}
}
]
}
TaskResponse
{
"allOf": [
{
"$ref": "#/components/schemas/TaskBase"
},
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagCompact"
},
"example": [
{
"gid": "59746",
"name": "Grade A"
}
],
"readOnly": true,
"description": "Array of tags associated with this task. In order to change tags on an existing task use `addTag` and `removeTag`."
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/TaskCompact"
},
{
"type": "object",
"nullable": true,
"readOnly": true,
"description": "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."
}
]
},
"assignee": {
"allOf": [
{
"$ref": "#/components/schemas/UserCompact"
},
{
"nullable": true
}
]
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
},
"readOnly": true,
"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."
},
"followers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCompact"
},
"readOnly": true,
"description": "Array of users following this task."
},
"workspace": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceCompact"
},
{
"type": "object",
"readOnly": true,
"description": "*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."
}
]
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldResponse"
},
"readOnly": true,
"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."
},
"permalink_url": {
"type": "string",
"example": "https://app.asana.com/0/resource/123456789/list",
"readOnly": true,
"description": "A url that points directly to the object within Asana."
},
"assignee_section": {
"allOf": [
{
"$ref": "#/components/schemas/SectionCompact"
},
{
"type": "object",
"nullable": true,
"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.\"\nThe `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."
}
]
}
}
}
]
}
TaskSetParentRequest
{
"type": "object",
"required": [
"parent"
],
"properties": {
"parent": {
"type": "string",
"example": "987654",
"description": "The new parent of the task, or `null` for no parent."
},
"insert_after": {
"type": "string",
"example": "null",
"description": "A subtask of the parent to insert the task after, or `null` to insert at the beginning of the list."
},
"insert_before": {
"type": "string",
"example": "124816",
"description": "A subtask of the parent to insert the task before, or `null` to insert at the end of the list."
}
}
}
TaskTemplateCompact
{
"allOf": [
{
"$ref": "#/components/schemas/AsanaResource"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Packing list",
"description": "Name of the task template."
}
},
"description": "A *task template* is an object that allows new tasks to be created with a predefined setup.",
"x-docs-overrides": {
"properties.resource_type.example": "task_template"
}
}
]
}
TaskTemplateInstantiateTaskRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "New Task",
"description": "The name of the new task. If not provided, the name of the task template will be used."
}
}
}
TaskTemplateRecipe
{
"allOf": [
{
"$ref": "#/components/schemas/TaskTemplateRecipeCompact"
},
{
"type": "object",
"properties": {
"due_time": {
"type": "string",
"example": "13:15:00.000Z",
"nullable": true,
"description": "The time of day that the task will be due"
},
"subtasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTemplateRecipeCompact"
},
"description": "Array of subtasks that will be added to the task created from this template"
},
"followers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCompact"
},
"description": "Array of users that will be added as followers to the task created from this template"
},
"dependents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTemplateRecipeCompact"
},
"description": "Array of task templates that will depend on the task created from this template"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentCompact"
},
"description": "Array of attachments that will be added to the task created from this template"
},
"description": {
"type": "string",
"example": "Please describe the bug you found and how to reproduce it.",
"description": "Description of the task that will be created from this template."
},
"memberships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
},
"description": "Array of projects that the task created from this template will be added to"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTemplateRecipeCompact"
},
"description": "Array of task templates that the task created from this template will depend on"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldCompact"
},
"description": "Array of custom fields that will be added to the task created from this template"
},
"relative_due_on": {
"type": "integer",
"example": 2,
"nullable": true,
"description": "The number of days after the task has been instantiated on which that the task will be due"
},
"html_description": {
"type": "string",
"example": "Please describe the bug you found and how to reproduce it.",
"description": "HTML description of the task that will be created from this template."
},
"relative_start_on": {
"type": "integer",
"example": 1,
"nullable": true,
"description": "The number of days after the task has been instantiated on which that the task will start"
}
}
}
]
}
TaskTemplateRecipeCompact
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Bug Report",
"description": "Name of the task that will be created from this template."
},
"task_resource_subtype": {
"enum": [
"default_task",
"milestone_task",
"approval_task"
],
"type": "string",
"example": "default_task",
"description": "The subtype of the task that will be created from this template."
}
}
}
]
}
TaskTemplateResponse
{
"allOf": [
{
"$ref": "#/components/schemas/TaskTemplateCompact"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Bug Report Template",
"description": "Name of the task template."
},
"project": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCompact"
}
],
"nullable": true,
"description": "The project that this task template belongs to."
},
"template": {
"$ref": "#/components/schemas/TaskTemplateRecipe"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2019-01-01T00:00:00.000Z",
"description": "The time at which this task template was created."
},
"created_by": {
"$ref": "#/components/schemas/UserCompact"
}
},
"x-konfig-properties": {
"template": {
"description": "The configuration for the task that will be created from this template."
},
"created_by": {
"description": "The user who created this task template."
}
}
}
]
}
TaskTemplatesDeleteTaskTemplateResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TaskTemplatesGetSingleTemplateResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskTemplateResponse"
}
}
}
TaskTemplatesInstantiateTaskJobRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskTemplateInstantiateTaskRequest"
}
}
}
TaskTemplatesInstantiateTaskJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JobCompact"
}
}
}
TaskTemplatesListMultipleResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTemplateCompact"
}
}
}
}
TasksAddFollowersToTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAddFollowersRequest"
}
}
}
TasksAddFollowersToTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksAddProjectToTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAddProjectRequest"
}
}
}
TasksAddProjectToTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksAddTagToTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAddTagRequest"
}
}
}
TasksAddTagToTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksCreateNewTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
TasksCreateNewTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksCreateSubtaskRecordRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
TasksCreateSubtaskRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksDeleteTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksDuplicateTaskJobRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskDuplicateRequest"
}
}
}
TasksDuplicateTaskJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JobCompact"
}
}
}
TasksGetAllDependenciesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetByCustomIdResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksGetDependentsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetMultipleResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetMultipleWithTagResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetSectionTasksResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetSubtaskListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetTaskRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksGetTasksByProjectResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksGetUserTaskListTasksResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
TasksRemoveFollowersFromTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskRemoveFollowersRequest"
}
}
}
TasksRemoveFollowersFromTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
TasksRemoveProjectFromTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskRemoveProjectRequest"
}
}
}
TasksRemoveProjectFromTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksRemoveTagFromTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskRemoveTagRequest"
}
}
}
TasksRemoveTagFromTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksSearchInWorkspaceResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskCompact"
}
}
}
}
TasksSetDependenciesForTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ModifyDependenciesRequest"
}
}
}
TasksSetDependenciesForTaskResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
TasksSetParentTaskRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskSetParentRequest"
}
}
}