Appearance
Add a project to a task
API ReferenceRequired scope: tasks:write
Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project.
addProject can also be used to reorder a task within a project or section that already contains it.
Positioning the task:
- Use
insert_beforeorinsert_afterwith a task ID to position relative to another task - Use
sectionalone to add the task to the end of a section - Use
sectionwithinsert_after: nullto add to the beginning of a section - Use
sectionwithinsert_before: nullto add to the end of a section - Use
sectionwithinsert_beforeorinsert_after(non-null) to position relative to a task within that section. The anchor task must be in the specified section.
At most one of insert_before or insert_after should be specified (both cannot be used together).
A task can have at most 20 projects multi-homed to it.
Returns an empty data block.
OpenAPI definition
json
{
"openapi": "3.0.0",
"info": {
"description": "This is the interface for interacting with the Asana Platform. Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).",
"x-public-description": "This is the interface for interacting with the Asana Platform. Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).",
"title": "Asana",
"termsOfService": "https://asana.com/terms",
"contact": {
"name": "Asana Support",
"url": "https://asana.com/support"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "1.0",
"x-docs-schema-whitelist": [
"AsanaResource",
"AsanaNamedResource",
"AuditLogEvent",
"AttachmentResponse",
"AttachmentCompact",
"BatchResponse",
"CustomFieldSettingResponse",
"CustomFieldSettingCompact",
"CustomTypeResponse",
"CustomTypeBase",
"CustomTypeCompact",
"CustomTypeStatusOptionResponse",
"CustomTypeStatusOptionBase",
"CustomTypeStatusOptionCompact",
"CustomFieldResponse",
"CustomFieldCompact",
"CustomFieldMembershipCompact",
"CustomFieldMembershipResponse",
"EnumOption",
"EventResponse",
"ErrorResponse",
"GoalResponse",
"GoalCompact",
"GoalMembershipCompact",
"GoalMembershipBase",
"GoalMembershipResponse",
"GoalRelationshipResponse",
"GoalRelationshipCompact",
"GraphExportResponse",
"GraphExportCompact",
"JobResponse",
"JobCompact",
"OrganizationExportResponse",
"OrganizationExportCompact",
"PortfolioMembershipResponse",
"PortfolioMembershipCompact",
"PortfolioResponse",
"PortfolioCompact",
"ProjectBriefResponse",
"ProjectBriefCompact",
"ProjectMembershipCompactResponse",
"ProjectMembershipNormalResponse",
"ProjectMembershipCompact",
"ProjectResponse",
"ProjectCompact",
"ProjectStatusResponse",
"ProjectStatusCompact",
"ProjectTemplateCompact",
"ProjectTemplateResponse",
"RuleTriggerResponse",
"ResourceExportResponse",
"ResourceExportCompact",
"ResourceExportCompact",
"RbacRoleResponse",
"RbacRoleCompact",
"SectionResponse",
"SectionCompact",
"StatusUpdateResponse",
"StatusUpdateCompact",
"StoryResponse",
"StoryCompact",
"TagResponse",
"TagCompact",
"TaskResponse",
"TaskCompact",
"TaskCountResponse",
"TeamMembershipResponse",
"TeamMembershipCompact",
"TeamResponse",
"TeamCompact",
"TimePeriodResponse",
"TimePeriodCompact",
"TimeTrackingCategoryResponse",
"TimeTrackingCategoryCompact",
"UserTaskListResponse",
"UserTaskListCompact",
"UserResponse",
"UserCompact",
"WebhookFilter",
"WebhookResponse",
"WebhookCompact",
"WorkspaceMembershipResponse",
"WorkspaceMembershipCompact",
"WorkspaceResponse",
"WorkspaceCompact"
]
},
"servers": [
{
"url": "https://app.asana.com/api/1.0",
"description": "Main endpoint."
}
],
"security": [
{
"personalAccessToken": []
},
{
"oauth2": []
}
],
"x-readme": {
"proxy-enabled": false
},
"tags": [
{
"name": "Tasks",
"description": "The task is the basic object around which many operations in Asana are centered. In the Asana application, multiple tasks populate the middle pane according to some view parameters, and the set of selected tasks determines the more detailed information presented in the details pane.\n\nSections are unique in that they will be included in the `memberships` field of task objects returned in the API when the task is within a section. They can also be used to manipulate the ordering of a task within a project.\n\n[Queries](/reference/tasks/gettasks) return a [compact representation of each task object](/reference/tasks/tasks). To retrieve *all* fields or *specific set* of the fields, use [field selectors](/guides/platform/inputoutput-options) to manipulate what data is included in a response."
}
],
"components": {
"parameters": {
"pretty": {
"name": "opt_pretty",
"in": "query",
"description": "Provides “pretty” output.\nProvides 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.",
"required": false,
"allowEmptyValue": true,
"schema": {
"type": "boolean"
},
"style": "form",
"example": true
},
"task_path_gid": {
"name": "task_gid",
"in": "path",
"required": true,
"description": "The task to operate on.",
"schema": {
"type": "string"
},
"example": "321654",
"x-env-variable": "task"
}
},
"responses": {
"BadRequest": {
"description": "This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"Unauthorized": {
"description": "A valid authentication token was not provided with the request, so the API could not associate a user with the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"Forbidden": {
"description": "The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"NotFound": {
"description": "Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"InternalServerError": {
"description": "There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"schemas": {
"EmptyResponse": {
"type": "object",
"description": "An empty object. Some endpoints do not return an object on success. The success is conveyed through a 2-- status code and returning an empty object."
},
"Error": {
"type": "object",
"properties": {
"message": {
"type": "string",
"readOnly": true,
"description": "Message providing more detail about the error that occurred, if available.",
"example": "project: Missing input"
},
"help": {
"type": "string",
"readOnly": true,
"description": "Additional information directing developers to resources on how to address and fix the problem, if available.",
"example": "For more information on API status codes and how to handle them, read the docs on errors: https://asana.github.io/developer-docs/#errors'"
},
"phrase": {
"type": "string",
"readOnly": true,
"description": "*500 errors only*. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana's logs.",
"example": "6 sad squid snuggle softly"
}
}
},
"ErrorResponse": {
"description": "Sadly, sometimes requests to the API are not successful. Failures can\noccur for a wide range of reasons. In all cases, the API should return\nan HTTP Status Code that indicates the nature of the failure,\nwith a response body in JSON format containing additional information.\n\n\nIn the event of a server error the response body will contain an error\nphrase. These phrases are automatically generated using the\nnode-asana-phrase\nlibrary and can be used by\nAsana support to quickly look up the incident that caused the server\nerror.",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"TaskAddProjectRequest": {
"type": "object",
"properties": {
"project": {
"description": "The project to add the task to.",
"type": "string",
"example": "13579"
},
"insert_after": {
"description": "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.",
"type": "string",
"nullable": true,
"example": "124816"
},
"insert_before": {
"description": "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.",
"type": "string",
"nullable": true,
"example": "432134"
},
"section": {
"description": "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.",
"type": "string",
"nullable": true,
"example": "987654"
}
},
"required": [
"project"
]
}
},
"securitySchemes": {
"personalAccessToken": {
"type": "http",
"description": "A personal access token allows access to the api for the user who created it. This should be kept a secret and be treated like a password.",
"scheme": "bearer"
},
"oauth2": {
"type": "oauth2",
"description": "We require that applications designed to access the Asana API on behalf of multiple users implement OAuth 2.0.\nAsana supports the Authorization Code Grant flow.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://app.asana.com/-/oauth_authorize",
"tokenUrl": "https://app.asana.com/-/oauth_token",
"refreshUrl": "https://app.asana.com/-/oauth_token",
"scopes": {
"default": "Provides access to all endpoints documented in our API reference. If no scopes are requested, this scope is assumed by default.",
"openid": "Provides access to OpenID Connect ID tokens and the OpenID Connect user info endpoint.",
"email": "Provides access to the user’s email through the OpenID Connect user info endpoint.",
"profile": "Provides access to the user’s name and profile photo through the OpenID Connect user info endpoint.",
"attachments:read": "View access to attachments",
"attachments:write": "Create and modify access to attachments",
"attachments:delete": "Delete access to attachments",
"custom_fields:read": "View access to custom fields",
"custom_fields:write": "Create and modify access to custom fields",
"goals:read": "View access to goals",
"jobs:read": "View access to jobs",
"ooo_entries:read": "View access to OOO entries",
"ooo_entries:write": "Create and modify access to OOO entries",
"ooo_entries:delete": "Delete access to OOO entries",
"tasks:read": "View access to tasks",
"tasks:write": "Create and modify access to tasks",
"tasks:delete": "Delete access to tasks",
"task_custom_types:read": "View access to task custom types",
"task_templates:read": "View access to task templates",
"team_memberships:read": "View access to team memberships",
"portfolios:read": "View access to portfolios",
"portfolios:write": "Create and modify access to portfolios",
"project_templates:read": "View access to project templates",
"project_portfolio_settings:read": "View access to project portfolio settings",
"project_portfolio_settings:write": "Create and modify access to project portfolio settings",
"projects:delete": "Delete access to projects",
"projects:read": "View access to projects",
"projects:write": "Create and modify access to projects",
"roles:read": "View access to roles",
"roles:write": "Create and modify access to roles",
"roles:delete": "Delete access to roles",
"users:read": "View access to users",
"teams:read": "View access to teams",
"time_tracking_categories:read": "View access to time tracking categories",
"time_tracking_categories:write": "Create and modify access to time tracking categories",
"time_tracking_categories:delete": "Delete access to time tracking categories",
"time_tracking_entries:read": "View access to time tracking entries",
"timesheet_approval_statuses:read": "View access to timesheet approval statuses",
"timesheet_approval_statuses:write": "Create and modify access to timesheet approval statuses",
"stories:read": "View access to stories",
"stories:write": "Create and modify access to stories",
"tags:read": "View access to tags",
"tags:write": "Create and modify access to tags",
"webhooks:read": "View access to webhooks",
"webhooks:write": "Create and modify access to webhooks",
"webhooks:delete": "Delete access to webhooks",
"workspaces:read": "View access to workspaces"
}
}
}
}
}
},
"paths": {
"/tasks/{task_gid}/addProject": {
"parameters": [
{
"$ref": "#/components/parameters/task_path_gid"
},
{
"$ref": "#/components/parameters/pretty"
}
],
"post": {
"summary": "Add a project to a task",
"description": "<b>Required scope: </b>tasks:write\n\nAdds the task to the specified project, in the optional location\nspecified. If no location arguments are given, the task will be added to\nthe end of the project.\n\n`addProject` can also be used to reorder a task within a project or\nsection that already contains it.\n\n**Positioning the task:**\n- Use `insert_before` or `insert_after` with a task ID to position relative to another task\n- Use `section` alone to add the task to the end of a section\n- Use `section` with `insert_after: null` to add to the **beginning** of a section\n- Use `section` with `insert_before: null` to add to the **end** of a section\n- Use `section` with `insert_before` or `insert_after` (non-null) to position relative to a task within that section. The anchor task must be in the specified section.\n\nAt most one of `insert_before` or `insert_after` should be specified (both cannot be used together).\n\nA task can have at most 20 projects multi-homed to it.\n\nReturns an empty data block.",
"tags": [
"Tasks"
],
"operationId": "addProjectForTask",
"requestBody": {
"description": "The project to add the task to.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAddProjectRequest"
}
}
},
"examples": {
"addToEndOfSection": {
"summary": "Add task to end of a section",
"value": {
"data": {
"project": "13579",
"section": "987654"
}
}
},
"addToBeginningOfSection": {
"summary": "Add task to beginning of a section",
"value": {
"data": {
"project": "13579",
"section": "987654"
}
}
},
"addAfterTaskInSection": {
"summary": "Add task after another task in a section",
"value": {
"data": {
"project": "13579",
"section": "987654",
"insert_after": "124816"
}
}
},
"addBeforeTaskInSection": {
"summary": "Add task before another task in a section",
"value": {
"data": {
"project": "13579",
"section": "987654",
"insert_before": "432134"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully added the specified project to the task.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"security": [
{
"personalAccessToken": []
},
{
"oauth2": [
"tasks:write"
]
}
],
"x-readme": {
"code-samples": [
{
"language": "java",
"install": "<dependency><groupId>com.asana</groupId><artifactId>asana</artifactId><version>1.0.0</version></dependency>",
"code": "import com.asana.Client;\n\nClient client = Client.accessToken(\"PERSONAL_ACCESS_TOKEN\");\n\nJsonElement result = client.tasks.addProjectForTask(taskGid)\n .data(\"field\", \"value\")\n .data(\"field\", \"value\")\n .option(\"pretty\", true)\n .execute();"
},
{
"language": "node",
"install": "npm install asana",
"code": "const Asana = require('asana');\n\nlet client = new Asana.ApiClient();\nclient.authentications.token.accessToken = '<YOUR_ACCESS_TOKEN>';\n\nlet tasksApiInstance = new Asana.TasksApi(client);\nlet body = {\"data\": {\"<PARAM_1>\": \"<VALUE_1>\", \"<PARAM_2>\": \"<VALUE_2>\",}}; // Object | The project to add the task to.\nlet task_gid = \"321654\"; // String | The task to operate on.\n\ntasksApiInstance.addProjectForTask(body, task_gid).then((result) => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error) => {\n console.error(error.response.body);\n});",
"name": "node-sdk-v3"
},
{
"language": "node",
"install": "npm install asana@1.0.5",
"code": "const asana = require('asana');\n\nconst client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN');\n\nclient.tasks.addProjectForTask(taskGid, {field: \"value\", field: \"value\", pretty: true})\n .then((result) => {\n console.log(result);\n });",
"name": "node-sdk-v1"
},
{
"language": "python",
"install": "pip install asana",
"code": "import asana\nfrom asana.rest import ApiException\nfrom pprint import pprint\n\nconfiguration = asana.Configuration()\nconfiguration.access_token = '<YOUR_ACCESS_TOKEN>'\napi_client = asana.ApiClient(configuration)\n\n# create an instance of the API class\ntasks_api_instance = asana.TasksApi(api_client)\nbody = {\"data\": {\"<PARAM_1>\": \"<VALUE_1>\", \"<PARAM_2>\": \"<VALUE_2>\",}} # dict | The project to add the task to.\ntask_gid = \"321654\" # str | The task to operate on.\n\n\ntry:\n # Add a project to a task\n api_response = tasks_api_instance.add_project_for_task(body, task_gid)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling TasksApi->add_project_for_task: %s\\n\" % e)",
"name": "python-sdk-v5"
},
{
"language": "python",
"install": "pip install asana==3.2.3",
"code": "import asana\n\nclient = asana.Client.access_token('PERSONAL_ACCESS_TOKEN')\n\nresult = client.tasks.add_project_for_task(task_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True)",
"name": "python-sdk-v3"
},
{
"language": "php",
"install": "composer require asana/asana",
"code": "<?php\nrequire 'vendor/autoload.php';\n\n$client = Asana\\Client::accessToken('PERSONAL_ACCESS_TOKEN');\n\n$result = $client->tasks->addProjectForTask($task_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true'))"
},
{
"language": "ruby",
"install": "gem install asana",
"code": "require 'asana'\n\nclient = Asana::Client.new do |c|\n c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN'\nend\n\nresult = client.tasks.add_project_for_task(task_gid: 'task_gid', field: \"value\", field: \"value\", options: {pretty: true})"
}
]
}
}
}
}
}