Asana
Connect to Asana to manage your projects and tasks. Supports task creation, updates, and management.
At Stack AI, security and privacy of our customer's data is our top priority. Today, we are thrilled to announce that Stack AI is now SOC 2 Type II and HIPAA compliant.
Connect to Asana to manage your projects and tasks. Supports task creation, updates, and management.
The following parameters are required to set up a connection to Asana.
Get the API key from the Personal access tokens section of your Asana account. You can find your tokens here: https://app.asana.com/0/my-apps.
A specific, existing allocation can be deleted by making a DELETE request on the URL for that allocation. Returns an empty data record.
None
3 output parameters
Returns the complete allocation record for a single allocation.
3 input parameters
3 output parameters
An existing allocation can be updated by making a PUT request on the URL for that allocation. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated allocation record.
4 input parameters
3 output parameters
Returns a list of allocations filtered to a specific project, user or placeholder.
7 input parameters
3 output parameters
Creates a new allocation. Returns the full record of the newly created allocation.
3 input parameters
3 output parameters
Deletes a specific, existing attachment. Returns an empty data record.
None
3 output parameters
Get the full record for a single attachment.
3 input parameters
3 output parameters
Returns the compact records for all attachments on the object. There are three possible `parent` values for this request: `project`, `project_brief`, and `task`. For a project, an attachment refers to a file uploaded to the "Key resources" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to `GET /attachments` for a task will return all of the images in the task, including inline images.
5 input parameters
3 output parameters
<b>Required scope: </b><code>attachments:write</code> Upload an attachment. This method uploads an attachment on an object and returns the compact record for the created attachment object. This is possible by either: - Providing the URL of the external resource being attached, or - Downloading the file content first and then uploading it as any other attachment. Note that it is not possible to attach files from third party services such as Dropbox, Box, Vimeo & Google Drive via the API The 100MB size limit on attachments in Asana is enforced on this endpoint. This endpoint expects a multipart/form-data encoded request containing the full contents of the file to be uploaded. Requests made should follow the HTTP/1.1 specification that line terminators are of the form `CRLF` or `\r\n` outlined [here](http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01#Basic-Rules) in order for the server to reli
3 input parameters
3 output parameters
Retrieve the audit log events that have been captured in your domain. This endpoint will return a list of [AuditLogEvent](/reference/audit-log-api) objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results. There are a number of query parameters (below) that can be used to filter the set of [AuditLogEvent](/reference/audit-log-api) objects that are returned in the response. Any combination of query parameters is valid. When no filters are provided, all of the events that have been captured in your domain will match. The list of events will always be [paginated](/docs/pagination). The default limit is 1000 events. The next set of events can be retrieved using the `offset` from the previous response. If there are no events that match the provided filters in your domain, the endpo
None
3 output parameters
Make multiple requests in parallel to Asana's API.
3 input parameters
3 output parameters
Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
5 input parameters
3 output parameters
Returns a list of all of the custom fields settings on a portfolio, in compact form.
5 input parameters
3 output parameters
Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field's name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field's type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.
3 input parameters
3 output parameters
A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record.
None
3 output parameters
Get the complete definition of a custom field's metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
3 input parameters
3 output parameters
A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field's `type` cannot be updated. An enum custom field's `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
4 input parameters
3 output parameters
Returns a list of the compact representation of all of the custom fields in a workspace.
5 input parameters
3 output parameters
Creates an enum option and adds it to this custom field's list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field's list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
4 input parameters
3 output parameters
Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
4 input parameters
3 output parameters
Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
4 input parameters
3 output parameters
Returns a list of all of the custom types associated with an object. Currently, only projects are supported. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
5 input parameters
3 output parameters
Returns the full record for all events that have occurred since the sync token was created. A `GET` request to the endpoint `/[path_to_resource]/events` can be made in lieu of including the resource ID in the data for the request. Asana limits a single sync token to 100 events. If more than 100 events exist for a given resource, `has_more: true` will be returned in the response, indicating that there are more events to pull. *Note: The resource returned will be the resource that triggered the event. This may be different from the one that the events were requested for. For example, a subscription to a project will contain events for tasks contained within the project.*
4 input parameters
3 output parameters
Returns the complete updated goal relationship record for a single goal relationship.
3 input parameters
3 output parameters
An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal relationship record.
4 input parameters
3 output parameters
Returns compact goal relationship records.
6 input parameters
3 output parameters
Creates a goal relationship by adding a supporting resource to a given goal. Returns the newly created goal relationship record.
4 input parameters
3 output parameters
Removes a goal relationship for a given parent goal.
1 input parameter
3 output parameters
A specific, existing goal can be deleted by making a DELETE request on the URL for that goal. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>goals:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>time_period</code></td> <td><code>time_periods:read</code></td> </tr> </table> Returns the complete goal record for a single goal.
3 input parameters
3 output parameters
An existing goal can be updated by making a PUT request on the URL for that goal. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal record.
4 input parameters
3 output parameters
<b>Required scope: </b><code>goals:read</code> Returns compact goal records.
11 input parameters
3 output parameters
Creates a new goal in a workspace or team. Returns the full record of the newly created goal.
3 input parameters
3 output parameters
Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists.
4 input parameters
3 output parameters
Updates a goal's existing metric's `current_number_value` if one exists, otherwise responds with a 400 status code. Returns the complete updated goal metric record.
4 input parameters
3 output parameters
Adds followers to a goal. Returns the goal the followers were added to. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
4 input parameters
3 output parameters
Removes followers from a goal. Returns the goal the followers were removed from. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
4 input parameters
3 output parameters
<b>Required scope: </b><code>goals:read</code> Returns a compact representation of all of the parent goals of a goal.
3 input parameters
3 output parameters
Returns the full record for a job.
3 input parameters
3 output parameters
Returns compact `goal_membership`, `project_membership`, `portfolio_membership`, or `custom_field_membership` records. The possible types for `parent` in this request are `goal`, `project`, `portfolio`, or `custom_field`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Team as members are not supported for portfolios or custom fields yet.
6 input parameters
3 output parameters
Creates a new membership in a `goal`, `project`, `portfolio`, or `custom_field`. Teams or Users can be members of `goals` or `projects`. Portfolios and custom fields only support `users` as members. Returns the full record of the newly created membership.
1 input parameter
3 output parameters
A specific, existing membership for a `goal`, `project`, `portfolio` or `custom_field` can be deleted by making a `DELETE` request on the URL for that membership. Returns an empty data record.
None
3 output parameters
Returns a `project_membership`, `goal_membership`, `portfolio_membership`, or `custom_field_membership` record for a membership id.
None
3 output parameters
An existing membership can be updated by making a `PUT` request on the membership. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Memberships on `goals`, `projects`, `portfolios`, and `custom_fields` can be updated. Returns the full record of the updated membership.
1 input parameter
3 output parameters
This method creates a request to export an Organization. Asana will complete the export at some point after you create the request.
3 input parameters
3 output parameters
Returns details of a previously-requested Organization export.
3 input parameters
3 output parameters
Returns a list of portfolio memberships in compact representation. You must specify `portfolio`, `portfolio` and `user`, or `workspace` and `user`.
7 input parameters
3 output parameters
Returns the complete portfolio record for a single portfolio membership.
3 input parameters
3 output parameters
Returns the compact portfolio membership records for the portfolio.
6 input parameters
3 output parameters
<b>Required scope: </b><code>portfolios:read</code> Returns a list of the portfolios in compact representation that are owned by the current API user.
6 input parameters
3 output parameters
Creates a new portfolio in the given workspace with the supplied name. Note that portfolios created in the Asana UI may have some state (like the “Priority” custom field) which is automatically added to the portfolio when it is created. Portfolios created via our API will *not* be created with the same initial state to allow integrations to create their own starting state on a portfolio.
3 input parameters
3 output parameters
An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>portfolios:read</code> Returns the complete portfolio record for a single portfolio.
3 input parameters
3 output parameters
An existing portfolio can be updated by making a PUT request on the URL for that portfolio. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated portfolio record.
4 input parameters
3 output parameters
<b>Required scope: </b><code>portfolios:read</code> Get a list of the items in compact form in a portfolio.
5 input parameters
3 output parameters
Add an item to a portfolio. Returns an empty data block.
1 input parameter
3 output parameters
Remove an item from a portfolio. Returns an empty data block.
1 input parameter
3 output parameters
Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio.
1 input parameter
3 output parameters
Removes a custom field setting from a portfolio.
1 input parameter
3 output parameters
Adds the specified list of users as members of the portfolio. Returns the updated portfolio record.
4 input parameters
3 output parameters
Removes the specified list of users from members of the portfolio. Returns the updated portfolio record.
4 input parameters
3 output parameters
Deletes a specific, existing project brief. Returns an empty data record.
None
3 output parameters
Get the full record for a project brief.
3 input parameters
3 output parameters
An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated project brief record.
4 input parameters
3 output parameters
Creates a new project brief. Returns the full record of the newly created project brief.
4 input parameters
3 output parameters
Returns the complete project record for a single project membership.
3 input parameters
3 output parameters
Returns the compact project membership records for the project.
6 input parameters
3 output parameters
*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Deletes a specific, existing project status update. Returns an empty data record.
None
3 output parameters
*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Returns the complete record for a single status update.
3 input parameters
3 output parameters
*Deprecated: new integrations should prefer the `/status_updates` route.* Returns the compact project status update records for all updates on the project.
5 input parameters
3 output parameters
*Deprecated: new integrations should prefer the `/status_updates` route.* Creates a new status update on the project. Returns the full record of the newly created project status update.
4 input parameters
3 output parameters
A specific, existing project template can be deleted by making a DELETE request on the URL for that project template. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>project_templates:read</code> Returns the complete project template record for a single project template.
3 input parameters
3 output parameters
<b>Required scope: </b><code>project_templates:read</code> Returns the compact project template records for all project templates in the given team or workspace.
6 input parameters
3 output parameters
<b>Required scope: </b><code>project_templates:read</code> Returns the compact project template records for all project templates in the team.
5 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Creates and returns a job that will asynchronously handle the project instantiation. To form this request, it is recommended to first make a request to [get a project template](/reference/getprojecttemplate). Then, from the response, copy the `gid` from the object in the `requested_dates` array. This `gid` should be used in `requested_dates` to instantiate a project. _Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the [is_organization](/reference/workspaces) parameter._
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:read</code> Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. *Note: This endpoint may timeout for large domains. Try filtering by team!*
7 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Create a new project in a workspace or team. Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the `workspace` parameter regardless of whether or not it is an organization. If the workspace for your project is an organization, you must also supply a `team` to share the project with. Returns the full record of the newly created project.
3 input parameters
3 output parameters
<b>Required scope: </b><code>projects:delete</code> A specific, existing project can be deleted by making a DELETE request on the URL for that project. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>projects:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>custom_field_settings</code></td> <td><code>custom_fields:read</code></td> </tr> <tr> <td><code>custom_fields</code></td> <td><code>custom_fields:read</code></td> </tr> </table> Returns the complete project record for a single project.
3 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> A specific, existing project can be updated by making a PUT request on the URL for that project. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task. Returns the complete updated project record.
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Creates and returns a job that will asynchronously handle the duplication.
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:read</code> Returns a compact representation of all of the projects the task is in.
5 input parameters
3 output parameters
<b>Required scope: </b><code>projects:read</code> Returns the compact project records for all projects in the team.
6 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Creates a project shared with the given team. Returns the full record of the newly created project.
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:read</code> Returns the compact project records for all projects in the workspace. *Note: This endpoint may timeout for large domains. Prefer the `/teams/{team_gid}/projects` endpoint.*
6 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Creates a project in the workspace. If the workspace for your project is an organization, you must also supply a team to share the project with. Returns the full record of the newly created project.
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project.
4 input parameters
3 output parameters
<b>Required scope: </b><code>projects:write</code> Removes a custom field setting from a project.
1 input parameter
3 output parameters
<b>Required scope: </b><code>projects:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>custom_field_settings</code></td> <td><code>custom_fields:read</code></td> </tr> <tr> <td><code>custom_fields</code></td> <td><code>custom_fields:read</code></td> </tr> </table> Get an object that holds task count fields. **All fields are excluded by default**. You must [opt in](/docs/inputoutput-options) using `opt_fields` to get any information from this endpoint. This endpoint has an additional [rate limit](/docs/rate-limits) and each field counts especially high against our [cost limits](/docs/rate-limits#cost-limits). Milestones are just tasks, so they are included in the `num_tasks`, `num_incomplete_tasks`, and `num_completed_tasks` counts.
3 input parameters
3 output parameters
Adds the specified list of users as members of the project. Note that a user being added as a member may also be added as a *follower* as a result of this operation. This is because the user's default notification settings (i.e., in the "Notifications" tab of "My Profile Settings") will override this endpoint's default behavior of setting "Tasks added" notifications to `false`. Returns the updated project record.
4 input parameters
3 output parameters
Removes the specified list of users from members of the project. Returns the updated project record.
4 input parameters
3 output parameters
Adds the specified list of users as followers to the project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. Therefore, if the users are not already members of the project, they will also become members as a result of this operation. Returns the updated project record.
4 input parameters
3 output parameters
Removes the specified list of users from following the project, this will not affect project membership status. Returns the updated project record.
4 input parameters
3 output parameters
Creates and returns a job that will asynchronously handle the project template creation.
4 input parameters
3 output parameters
Trigger a rule which uses an ["incoming web request"](/docs/incoming-web-requests) trigger.
1 input parameter
3 output parameters
A specific, existing section can be deleted by making a DELETE request on the URL for that section. Note that sections must be empty to be deleted. The last remaining section cannot be deleted. Returns an empty data block.
None
3 output parameters
Returns the complete record for a single section.
3 input parameters
3 output parameters
A specific, existing section can be updated by making a PUT request on the URL for that project. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the `name` field.) When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task. Returns the complete updated section record.
4 input parameters
3 output parameters
Returns the compact records for all sections in the specified project.
5 input parameters
3 output parameters
Creates a new section in a project. Returns the full record of the newly created section.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Add a task to a specific, existing section. This will remove the task from other sections of the project. The task will be inserted at the top of a section unless an insert_before or insert_after parameter is declared. This does not work for separators (tasks with the resource_subtype of section).
1 input parameter
3 output parameters
Move sections relative to each other. One of `before_section` or `after_section` is required. Sections cannot be moved between projects. Returns an empty data block.
1 input parameter
3 output parameters
Deletes a specific, existing status update. Returns an empty data record.
None
3 output parameters
Returns the complete record for a single status update.
3 input parameters
3 output parameters
Returns the compact status update records for all updates on the object.
6 input parameters
3 output parameters
Creates a new status update on an object. Returns the full record of the newly created status update.
5 input parameters
3 output parameters
Deletes a story. A user can only delete stories they have created. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>stories:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>previews</code></td> <td><code>attachments:read</code></td> </tr> <tr> <td><code>attachments</code></td> <td><code>attachments:read</code></td> </tr> </table> Returns the full record for a single story.
3 input parameters
3 output parameters
Updates the story and returns the full record for the updated story. Only comment stories can have their text updated, and only comment stories and attachment stories can be pinned. Only one of `text` and `html_text` can be specified.
4 input parameters
3 output parameters
<b>Required scope: </b><code>stories:read</code> Returns the compact records for all stories on the task.
5 input parameters
3 output parameters
Adds a story to a task. This endpoint currently only allows for comment stories to be created. The comment will be authored by the currently authenticated user, and timestamped when the server receives the request. Returns the full record for the new story added to the task.
4 input parameters
3 output parameters
Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
5 input parameters
3 output parameters
Creates a new tag in a workspace or organization. Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization. Returns the full record of the newly created tag.
3 input parameters
3 output parameters
A specific, existing tag can be deleted by making a DELETE request on the URL for that tag. Returns an empty data record.
None
3 output parameters
Returns the complete tag record for a single tag.
3 input parameters
3 output parameters
Updates the properties of a tag. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the tag. Returns the complete updated tag record.
4 input parameters
3 output parameters
Get a compact representation of all of the tags the task has.
5 input parameters
3 output parameters
Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
5 input parameters
3 output parameters
Creates a new tag in a workspace or organization. Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization. Returns the full record of the newly created tag.
4 input parameters
3 output parameters
Returns the compact task template records for some filtered set of task templates. You must specify a `project`
5 input parameters
3 output parameters
A specific, existing task template can be deleted by making a DELETE request on the URL for that task template. Returns an empty data record.
None
3 output parameters
Returns the complete task template record for a single task template.
3 input parameters
3 output parameters
Creates and returns a job that will asynchronously handle the task instantiation.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a `project` or `tag` if you do not specify `assignee` and `workspace`. For more complex task retrieval, use [workspaces/{workspace_gid}/tasks/search](/reference/searchtasksforworkspace).
10 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Creating a new task is as easy as POSTing to the `/tasks` endpoint with a data block containing the fields you'd like to set on the task. Any unspecified fields will take on default values. Every task is required to be created in a specific workspace, and this workspace cannot be changed once set. The workspace need not be set explicitly if you specify `projects` or a `parent` task instead.
3 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:delete</code> A specific, existing task can be deleted by making a DELETE request on the URL for that task. Deleted tasks go into the “trash” of the user making the delete request. Tasks can be recovered from the trash within a period of 30 days; afterward they are completely removed from the system. Returns an empty data record.
None
3 output parameters
<b>Required scope: </b><code>tasks:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>memberships</code></td> <td><code>projects:read</code>, <code>project_sections:read</code></td> </tr> <tr> <td><code>actual_time_minutes</code></td> <td><code>time_tracking_entries:read</code></td> </tr> <tr> <td><code>custom_fields</code></td> <td><code>custom_fields:read</code></td> </tr> </table> Returns the complete task record for a single task.
3 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> A specific, existing task can be updated by making a PUT request on the URL for that task. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task. Returns the complete updated task record.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Creates and returns a job that will asynchronously handle the duplication.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time.
6 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> *Board view only*: Returns the compact section records for all tasks within the given section.
6 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time.
5 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact list of tasks in a user's My Tasks list. *Note: Access control is enforced for this endpoint as with all Asana API endpoints, meaning a user's private tasks will be filtered out if the API-authenticated user does not have access to them.* *Note: Both complete and incomplete tasks are returned by default unless they are filtered out (for example, setting `completed_since=now` will return only incomplete tasks, which is the default view for “My Tasks” in Asana.)*
6 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns a compact representation of all of the subtasks of a task.
5 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> parent, or no parent task at all. Returns an empty data block. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact representations of all of the dependencies of a task.
5 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Marks a set of tasks as dependencies of this task, if they are not already dependencies. *A task can have at most 30 dependents and dependencies combined*.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Unlinks a set of dependencies from this task.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the compact representations of all of the dependents of a task.
5 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Marks a set of tasks as dependents of this task, if they are not already dependents. *A task can have at most 30 dependents and dependencies combined*.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Unlinks a set of dependents from this task.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> 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. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. A task can have at most 20 projects multi-homed to it. Returns an empty data block.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Removes the task from the specified project. The task will still exist in the system, but it will not be in the project anymore. Returns an empty data block.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Adds a tag to a task. Returns an empty data block.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Removes a tag from a task. Returns an empty data block.
1 input parameter
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Adds followers to a task. Returns an empty data block. Each task can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated task record, described above.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:write</code> Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task.
4 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> <table> <tr> <th>Field</th> <th>Required Scope</th> </tr> <tr> <td><code>memberships</code></td> <td><code>projects:read</code>, <code>project_sections:read</code></td> </tr> <tr> <td><code>actual_time_minutes</code></td> <td><code>time_tracking_entries:read</code></td> </tr> <tr> <td><code>custom_fields</code></td> <td><code>custom_fields:read</code></td> </tr> </table> Returns a task given a custom ID shortcode.
None
3 output parameters
<b>Required scope: </b><code>tasks:read</code> To mirror the functionality of the Asana web app's advanced search feature, the Asana API has a task search endpoint that allows you to build complex filters to find and retrieve the exact data you need. #### Premium access Like the Asana web product's advance search feature, this search endpoint will only be available to premium Asana users. A user is premium if any of the following is true: - The workspace in which the search is being performed is a premium workspace - The user is a member of a premium team inside the workspace Even if a user is only a member of a premium team inside a non-premium workspace, search will allow them to find data anywhere in the workspace, not just inside the premium team. Making a search request using credentials of a non-premium user will result in a `402 Payment Required` error. #### Pagination Search results are not stable; r
56 input parameters
3 output parameters
Returns the complete team membership record for a single team membership.
3 input parameters
3 output parameters
Returns compact team membership records.
7 input parameters
3 output parameters
Returns the compact team memberships for the team.
5 input parameters
3 output parameters
Returns the compact team membership records for the user.
6 input parameters
3 output parameters
Creates a team within the current workspace.
3 input parameters
3 output parameters
<b>Required scope: </b><code>teams:read</code> Returns the full record for a single team.
3 input parameters
3 output parameters
Updates a team within the current workspace.
4 input parameters
3 output parameters
<b>Required scope: </b><code>teams:read</code> Returns the compact records for all teams in the workspace visible to the authorized user.
5 input parameters
3 output parameters
<b>Required scope: </b><code>teams:read</code> Returns the compact records for all teams to which the given user is assigned.
6 input parameters
3 output parameters
The user making this call must be a member of the team in order to add others. The user being added must exist in the same organization as the team. Returns the complete team membership record for the newly added user.
4 input parameters
3 output parameters
The user making this call must be a member of the team in order to remove themselves or others.
1 input parameter
3 output parameters
Returns the full record for a single time period.
3 input parameters
3 output parameters
Returns compact time period records.
7 input parameters
3 output parameters
Returns time tracking entries for a given task.
5 input parameters
3 output parameters
Creates a time tracking entry on a given task. Returns the record of the newly created time tracking entry.
4 input parameters
3 output parameters
A specific, existing time tracking entry can be deleted by making a `DELETE` request on the URL for that time tracking entry. Returns an empty data record.
None
3 output parameters
Returns the complete time tracking entry record for a single time tracking entry.
3 input parameters
3 output parameters
A specific, existing time tracking entry can be updated by making a `PUT` request on the URL for that time tracking entry. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task. Returns the complete updated time tracking entry record.
4 input parameters
3 output parameters
<b>Required scope: </b><code>workspace.typeahead:read</code> Retrieves objects in the workspace based via an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won't be able to fetch large numbers of results. The typeahead search API provides search for objects from a single workspace. This endpoint should be used to query for objects when creating an auto-completion/typeahead search feature. This API is meant to provide results quickly and should not be relied upon for accurate or exhaustive search results. The results sets are limited in size and cannot be paginated. Queries return a compact representation of each object which is typically the gid and name fields. Interested in a specific set of fields or all of
7 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the full record for a user task list.
3 input parameters
3 output parameters
<b>Required scope: </b><code>tasks:read</code> Returns the full record for a user's task list.
4 input parameters
3 output parameters
<b>Required scope: </b><code>users:read</code> Returns the user records for all users in all workspaces and organizations accessible to the authenticated user. Accepts an optional workspace ID parameter. Results are sorted by user ID.
6 input parameters
3 output parameters
<b>Required scope: </b><code>users:read</code> Returns the full user record for the single user with the provided ID.
3 input parameters
3 output parameters
<b>Required scope: </b><code>users:read</code> Returns all of a user's favorites within a specified workspace and of a given type. The results are ordered exactly as they appear in the user's Asana sidebar in the web application. Note that this endpoint currently only returns favorites for the current user (i.e., the user associated with the authentication token).
7 input parameters
3 output parameters
<b>Required scope: </b><code>users:read</code> Returns the compact records for all users that are members of the team. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint.
4 input parameters
3 output parameters
<b>Required scope: </b><code>users:read</code> Returns the compact records for all users in the specified workspace or organization. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint.
4 input parameters
3 output parameters
Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace.
6 input parameters
3 output parameters
Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook's confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in
3 input parameters
3 output parameters
This method *permanently* removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued.
None
3 output parameters
Returns the full record for the given webhook.
3 input parameters
3 output parameters
An existing webhook's filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook's previous `filters` array will be completely overwritten by the `filters` sent in the PUT request.
4 input parameters
3 output parameters
Returns the complete workspace record for a single workspace membership.
3 input parameters
3 output parameters
Returns the compact workspace membership records for the user.
5 input parameters
3 output parameters
Returns the compact workspace membership records for the workspace.
6 input parameters
3 output parameters
<b>Required scope: </b><code>workspaces:read</code> Returns the compact records for all workspaces visible to the authorized user.
4 input parameters
3 output parameters
<b>Required scope: </b><code>workspaces:read</code> Returns the full workspace record for a single workspace.
3 input parameters
3 output parameters
A specific, existing workspace can be updated by making a PUT request on the URL for that workspace. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. Currently the only field that can be modified for a workspace is its name. Returns the complete, updated workspace record.
4 input parameters
3 output parameters
Add a user to a workspace or organization. The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user.
4 input parameters
3 output parameters
Remove a user from a workspace or organization. The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address. Returns an empty data record.
1 input parameter
3 output parameters
Returns the full record for all events that have occurred since the sync token was created. The response is a list of events and the schema of each event is as described [here](/reference/events). Asana limits a single sync token to 1000 events. If more than 1000 events exist for a given domain, `has_more: true` will be returned in the response, indicating that there are more events to pull.
None
3 output parameters