Asana

Deletes a specific project in asana based on its unique identifier (gid). this endpoint permanently removes the project and all its associated tasks, making it irretrievable. use this endpoint when you need to completely remove a project from your asana workspace or organization. it’s important to note that this action cannot be undone, so it should be used with caution. this endpoint does not return any data upon successful deletion; it typically returns a 204 no content status code to indicate that the project has been successfully removed.

Action Parameters

Action Response

Retrieves all tasks within a specified section in asana. this endpoint allows users to fetch a list of tasks that are organized under a particular section of a project. it’s useful for getting an overview of work items grouped together for better project management. the endpoint should be used when you need to access or display all tasks associated with a specific section, such as for reporting, task management, or synchronization with other systems. it does not modify any data and is ideal for read-only operations. note that this endpoint only returns tasks directly assigned to the specified section and does not include tasks from subsections or provide detailed information about the section itself.

Action Parameters

Action Response

Updates an existing allocation in asana. this endpoint allows you to modify various aspects of an allocation, including its time range, effort, assignee, and associated project. it’s particularly useful for adjusting resource allocations in response to changes in project timelines, resource availability, or workload distribution. the endpoint requires the unique identifier of the allocation to be updated and accepts a data object containing the fields to be modified. use this endpoint when you need to alter the details of an existing allocation without creating a new one. note that partial updates are supported, meaning you only need to include the fields you want to change in the request body.

Action Parameters

Action Response

This endpoint updates an existing project brief in asana. it allows you to modify the title and content of a project brief, which is used to explain the purpose and goals of a project to the team. you can update the brief using either html-formatted text or plain text. the endpoint requires the project brief’s unique identifier (gid) and accepts a json object with the fields to be updated. it’s useful for keeping project documentation current and ensuring team alignment on project objectives and details.

Action Parameters

Action Response

Retrieves a list of project templates available in the specified asana workspace. this endpoint is part of asana’s project template api and is used to fetch standardized project setups that can be used to create new projects quickly. it’s particularly useful for teams that frequently start similar projects and want to maintain consistency in project structure. the endpoint returns a collection of project template objects, each containing details such as the template name, description, and associated tasks or sections. use this endpoint when you need to view available templates before creating a new project or when managing template libraries within your asana workspace. note that this endpoint replaces the deprecated ‘is template’ field method and aligns with asana’s new project template data model.

Action Parameters

Action Response

This endpoint performs a typeahead search within a specified asana workspace. it allows users to quickly find and retrieve information about objects (such as tasks, projects, or users) in the workspace based on partial input. this functionality is particularly useful for implementing auto-complete features in user interfaces or for efficiently locating specific items within a large workspace. the search is limited to the scope of the specified workspace, providing targeted and relevant results. while the exact search criteria and return format are not specified in the schema, typical implementations would likely accept a search string and return matching objects with their basic details.

Action Parameters

Action Response

Retrieves detailed information about a specific team membership in asana. this endpoint allows you to fetch the current state and properties of a user’s membership within a team. it’s useful for verifying a user’s team association, checking membership details, or auditing team composition. the endpoint should be used when you need to access up-to-date information about a particular team membership, such as the user’s role within the team or the date they joined. it will not modify the membership or provide information about other team members. this tool is particularly valuable for team management, user role verification, and maintaining accurate team records in asana-integrated applications.

Action Parameters

Action Response

Updates an existing comment story in asana. this endpoint allows you to modify the content, appearance, and status of a story associated with a task or project. use this when you need to edit a comment, change its pinned status, or update the sticker associated with it. the endpoint is particularly useful for correcting mistakes, adding new information to existing comments, or changing the visual emphasis of a story within asana’s interface. note that you can update either the plain text or html-formatted content of the comment, but not both simultaneously. the update will reflect immediately in the asana interface for all team members with access to the associated task or project.

Action Parameters

Action Response

Retrieves a list of events from asana related to tasks, projects, and other asana objects. this endpoint allows you to monitor activity and changes within your asana workspace or organization. it’s particularly useful for building real-time integrations, activity feeds, or maintaining synchronized data with external systems. the events are returned in chronological order, with the most recent events first. use this endpoint when you need to track changes, automate workflows based on asana activities, or create custom activity logs. note that this endpoint may have rate limits and doesn’t provide direct access to task or project data - it only provides information about changes and actions taken on these objects.

Action Parameters

Action Response

The adddependents endpoint allows you to establish task dependencies by adding a list of dependent tasks to a specific task in asana. this endpoint is crucial for managing complex project workflows where certain tasks rely on the completion of others. use this endpoint when you need to set up or modify task dependencies programmatically, such as when automating project setup or adjusting task relationships based on changing project requirements. the endpoint accepts a task gid and a list of dependent task gids, enabling you to create multiple dependencies in a single api call. it’s important to note that this endpoint only adds dependencies; it does not remove existing ones or provide information about current dependencies.

Action Parameters

Action Response

Retrieves a list of attachments associated with a specific parent resource (task, project, or project brief) in asana. this endpoint allows users to access files, images, and other media that have been uploaded to asana resources. it’s useful for gathering all related documents for a particular work item or project. the endpoint supports pagination for handling large numbers of attachments. it should be used when you need to review, download, or manage attachments within your asana workspace. note that this endpoint only provides metadata about the attachments; to access the actual file content, you may need to use a separate download url provided in the attachment metadata.

Action Parameters

Action Response

Creates a new tag within a specified asana workspace. this endpoint allows you to add a custom label (tag) that can be attached to tasks for better organization and categorization. use this when you need to introduce a new way of grouping or filtering tasks across projects within a workspace. the created tag can have a name, color, description, and designated followers. it’s particularly useful for implementing consistent task categorization schemes or setting up new organizational systems within your asana workspace. note that tags are workspace-specific and cannot be shared across different workspaces. this endpoint doesn’t attach the tag to any tasks; it only creates the tag for future use.

Action Parameters

Action Response

Retrieves detailed information about a specific project brief in asana using its unique identifier. this endpoint allows users to fetch the content and metadata of a project brief, which serves as a central document outlining key project information such as objectives, timelines, and scope. it’s particularly useful when you need to programmatically access or update project brief information, integrate project data into other systems, or build automation workflows around project management processes. the endpoint returns comprehensive data about the specified project brief, enabling developers to extract and utilize this information in their applications or reporting tools.

Action Parameters

Action Response

Retrieves a list of users in the asana platform. this endpoint allows you to fetch information about users, such as their names, email addresses, and other profile details. it’s particularly useful for getting an overview of team members, managing user accounts, or synchronizing user data with external systems. the endpoint supports pagination to handle large sets of users efficiently. you can filter users by workspace or team, making it easier to manage users within specific organizational units. note that the response will only include users that the authenticated user has permission to see, based on their access level and workspace memberships.

Action Parameters

Action Response

Updates an existing goal in asana with the provided information. this endpoint allows you to modify various attributes of a goal, such as its name, description, dates, status, and associations. it’s particularly useful for keeping goal information current as progress is made or circumstances change. the endpoint requires the unique identifier of the goal to be updated and accepts a data object containing the fields to be modified. it’s important to note that all fields in the data object are optional, allowing for partial updates of the goal. after successful execution, the endpoint returns the complete updated goal object, reflecting all changes made.

Action Parameters

Action Response

Retrieves a list of projects associated with a specific task in asana. this endpoint allows users to identify all projects that contain the given task, providing valuable context for task management and project organization. it’s particularly useful for understanding the broader scope of a task across multiple projects or for tracking cross-project dependencies. the endpoint should be used when you need to determine which projects a task belongs to, especially in scenarios involving task migration, project auditing, or generating comprehensive task reports. note that this endpoint only returns project associations and does not provide detailed information about the projects themselves or the task’s status within each project.

Action Parameters

Action Response

Retrieves detailed information about a specific story (comment or note) in asana using its unique identifier (gid). this endpoint allows you to fetch the content, metadata, and other relevant details of a single story associated with a task or project. use this when you need to access or display the full content of a particular comment or system-generated note. it’s particularly useful for displaying the complete text of longer comments, retrieving the exact timestamp of when a note was added, or gathering information about who authored a specific comment. this endpoint does not provide information about the task or project the story is attached to, nor does it allow for modification of the story content.

Action Parameters

Action Response

Adds one or more followers to a specific asana project. this endpoint allows you to expand the group of users who receive updates and notifications about the project’s activity. it’s useful for including team members or stakeholders in project communications without necessarily assigning them tasks. the endpoint requires the project’s unique identifier and a list of user identifiers to be added as followers. it’s important to note that this action only adds followers and does not remove existing ones. use this when you need to keep additional team members informed about a project’s progress or when onboarding new team members to an existing project.

Action Parameters

Action Response

This endpoint allows you to add a specific tag to a task in asana. it is used to categorize and organize tasks within your asana workspace. the endpoint requires the task’s unique identifier (gid) as part of the url path and the tag’s gid in the request body. this operation is useful for enhancing task metadata, improving searchability, and grouping related tasks. note that you can only add one tag per api call, so multiple calls may be necessary to add several tags to a single task.

Action Parameters

Action Response

Retrieves a list of all memberships for a specified team in asana. this endpoint allows you to fetch detailed information about who is part of a particular team, including both active and inactive members. use this when you need to audit team composition, manage access, or sync team data with other systems. the endpoint returns membership details but does not provide full user profiles or project-specific information. it’s particularly useful for large organizations managing multiple teams or for applications that need to keep team rosters up-to-date.

Action Parameters

Action Response

This endpoint allows you to add a new story (comment or activity) to a specific task in asana. it’s used to create comments, add stickers, or record other activities related to a task. the story can include plain text or html-formatted content, and can optionally be pinned or include a sticker. this is useful for team communication, task updates, or adding context to task progress. the endpoint requires the task’s unique identifier and details about the story to be added. it’s important to note that text and html text are mutually exclusive, and the sticker name must be from a predefined list if used.

Action Parameters

Action Response

Creates or updates a membership in an asana project or goal. this endpoint allows you to add a user or team to a project or goal, or modify their existing access level. use this when you need to grant or change access for a member in a specific project or goal. it’s particularly useful for managing team collaborations and setting up appropriate permissions. note that while you can still use the ‘role’ parameter, it’s recommended to use ‘access level’ for new integrations as ‘role’ is deprecated.

Action Parameters

Action Response

Retrieves a list of audit log events for a specified asana workspace. this endpoint allows users to access a comprehensive record of critical actions and changes made within the workspace, such as user logins, task updates, and project modifications. it’s particularly useful for monitoring activity, ensuring compliance, and investigating security concerns within an organization’s asana environment. the endpoint returns detailed information about each event, likely including timestamps, user information, and the nature of the action performed.

Action Parameters

Action Response

Retrieves a list of tasks associated with a specific tag in asana. this endpoint allows you to fetch all tasks that have been tagged with a particular tag, enabling efficient task management and organization. use this endpoint when you need to view or process tasks grouped under a specific category or label. it’s particularly useful for filtering tasks based on project phases, priorities, or any custom categorization implemented through tags. the endpoint returns task details, but note that it doesn’t modify tasks or tags; it’s purely for retrieval purposes. keep in mind that the response may be paginated for large sets of tasks, requiring multiple api calls for complete data retrieval.

Action Parameters

Action Response

Retrieves all tags associated with a specific task in asana. this endpoint allows you to fetch the complete list of tags that have been applied to a given task, identified by its unique task gid. use this endpoint when you need to understand how a particular task is categorized or labeled within your asana workspace. it’s particularly useful for filtering, organizing, or analyzing tasks based on their tags. the endpoint returns only the tags directly associated with the specified task and does not provide information about the task itself or other related entities. keep in mind that the number of tags returned may vary depending on how extensively the task has been tagged in asana.

Action Parameters

Action Response

Retrieves detailed information about a specific workspace membership in asana. this endpoint allows you to fetch the current state and attributes of a user’s membership within a particular workspace. it should be used when you need to access or verify the details of a user’s association with a workspace, such as their role, permissions, or other membership-specific information. this endpoint is particularly useful for auditing workspace access, managing team memberships, or integrating asana workspace data with other systems. note that while this endpoint provides membership details, it does not modify the membership or provide information about the workspace itself beyond the context of the specified membership.

Action Parameters

Action Response

Retrieves information about goal relationships in asana. this endpoint allows users to fetch data on how different goals within an organization are connected or related to each other. it is particularly useful for project managers and team leaders who need to understand the interdependencies between various objectives, track progress across related goals, and maintain alignment in complex project structures. the endpoint can be used to visualize goal hierarchies, identify potential conflicts or synergies between goals, and support strategic decision-making in project management. while it provides valuable insights into goal structures, it does not modify any goal data or relationships. note that the specific filtering capabilities and the granularity of returned data may vary, and users should refer to the asana documentation for the most up-to-date information on response formats and any query parameters that might be available for customizing the request.

Action Parameters

Action Response

This endpoint allows you to permanently delete a specific status update from asana. it removes the status update associated with the provided global id (gid) from the system. use this endpoint when you need to remove outdated, incorrect, or unnecessary status updates from a project, goal, or portfolio. it’s important to note that this action is irreversible, and once a status update is deleted, it cannot be recovered. this endpoint should be used cautiously, as it permanently removes information from your asana workspace. it does not provide any information about the deleted status update or confirm its previous existence.

Action Parameters

Action Response

The duplicatetask endpoint creates a copy of an existing task in asana with specified fields. it allows users to quickly replicate tasks while customizing which aspects of the original task should be carried over to the new one. this endpoint is particularly useful for creating repetitive tasks or setting up similar tasks across different projects. it provides flexibility in choosing which elements of the task to duplicate, from basic details like notes and assignees to more complex relationships like subtasks and dependencies. the endpoint requires the original task’s gid, a name for the new task, and a list of fields to include in the duplication. it’s important to note that while you can specify which fields to duplicate, you cannot modify their content during this operation - the values will be copied as-is from the original task.

Action Parameters

Action Response

Updates an existing enum option for a custom field in asana. this endpoint allows you to modify the properties of an enum option, such as its name, enabled status, and color. it’s particularly useful for maintaining and adjusting custom field options as project requirements evolve. you should use this when you need to change the attributes of an existing enum option or disable it without removing it entirely from the system. it’s important to note that this endpoint cannot be used to create new enum options or change their order in the list. the updated enum option retains its position in the custom field’s option list.

Action Parameters

Action Response

Retrieves a list of items (projects and/or portfolios) contained within a specified asana portfolio. this endpoint is used to get an overview of all the work organized under a particular portfolio. it’s particularly useful for understanding the structure and content of a portfolio, which can help in project management and work organization. the endpoint returns both projects and sub-portfolios that are directly associated with the specified portfolio. note that this endpoint may have limitations on the number of items returned in a single request, potentially requiring pagination for portfolios with a large number of items (the limit is 1500 items per portfolio).

Action Parameters

Action Response

Retrieves detailed information about a specific asana user using their unique identifier (user gid). this endpoint allows you to fetch a user’s profile data, which may include their name, email address, role within the organization, and other relevant details. it’s particularly useful for getting up-to-date information about a team member, verifying a user’s status, or displaying user profiles within your application. the endpoint should be used when you need to access or display detailed information about a particular asana user. note that the level of detail in the response may depend on the authentication and permissions of the requesting user. this endpoint does not modify any user data and is intended for read-only operations.

Action Parameters

Action Response

Inserts a new enum option into a specific position within an existing custom field’s enum options in asana. this endpoint allows for precise control over the order of enum options, which is crucial for maintaining the desired structure of custom fields. use this when you need to add a new option to an enum-type custom field and want to specify its exact position relative to existing options. the endpoint requires the custom field’s gid and the new enum option’s gid, with optional parameters to define its position. it’s important to note that you can specify either the option to insert before or after, but not both simultaneously.

Action Parameters

Action Response

Creates a new enum option for a specified custom field in asana. this endpoint allows you to add a predefined value to an enum-type custom field, expanding the set of selectable options for users. the new enum option can be customized with a name, color, and specific position within the existing options list. this tool is useful for dynamically updating custom fields to reflect changes in project requirements or organizational processes. it’s important to note that while you can create and disable enum options, they cannot be permanently deleted. use this endpoint when you need to add new categories, statuses, or predefined values to your custom fields in asana.

Action Parameters

Action Response

Retrieves allocation data for resources within an asana workspace. this endpoint supports resource management and capacity planning, providing information on team member assignments to projects over time. it’s useful for analyzing resource distribution and planning project staffing. the endpoint allows filtering by user, project, and date range for flexible querying.

Action Parameters

Action Response

Removes specified users as followers from a goal in asana. this endpoint allows you to unsubscribe users from receiving updates about a particular goal, which is useful for managing notifications and collaboration settings. it should be used when you need to adjust the list of users following a goal, such as when a team member’s role changes or they no longer need to be informed about the goal’s progress. the endpoint requires the goal’s unique identifier and a list of user identifiers to be removed. note that removing a follower does not affect their project membership or permissions; it only stops them from receiving automatic updates about the goal.

Action Parameters

Action Response

This endpoint allows users to upload files or link external resources as attachments to asana tasks, projects, or project briefs. it supports various attachment types including direct file uploads and external links from services like dropbox, google drive, and others. the endpoint is particularly useful for adding supplementary information, documentation, or resources to asana work items. when uploading files, use multipart/form-data content type. for external resources, provide the necessary url and name. the endpoint offers flexibility in attachment types and integration with app components for enhanced functionality.

Action Parameters

Action Response

Retrieves detailed information about a specific organization export in asana. this endpoint is used to check the status, progress, and details of a previously requested full data export for an enterprise-level organization. it allows users to monitor the export process, verify its completion, and obtain necessary information for downloading the exported data. this tool is particularly useful for large-scale data backups, migrations, or compliance-related activities. note that this endpoint only provides information about the export; it does not initiate a new export or download the exported data directly. the export process may take some time to complete, depending on the size of the organization’s data.

Action Parameters

Action Response

Removes specified dependencies from a task in asana. this endpoint allows you to unlink tasks that were previously set as dependencies for the given task. it’s useful when the relationship between tasks has changed, and they are no longer dependent on each other. the endpoint requires the global id (gid) of the task from which dependencies will be removed, and an array of task gids representing the dependencies to be removed. this operation helps in maintaining an up-to-date and accurate representation of task relationships within a project.

Action Parameters

Action Response

This endpoint adds a supporting relationship to a goal in asana, allowing you to link goals, projects, tasks, or portfolios as supporting resources. it’s used to create hierarchical structures within goals, enabling better organization and progress tracking. the endpoint is particularly useful for building complex goal structures, managing subgoals, and defining how different resources contribute to a goal’s progress. when adding subgoals, you can specify their position relative to existing subgoals. note that the contribution weight parameter allows fine-tuning of how supporting resources affect the parent goal’s progress calculation.

Action Parameters

Action Response

Executes a specific rule trigger in asana, allowing for automated actions based on predefined conditions. this endpoint is used to manually initiate a rule trigger, passing necessary data for the associated action. it’s particularly useful for testing rule configurations or triggering automated workflows programmatically. the endpoint requires specifying a task resource and custom action data, making it versatile for various automation scenarios. note that this feature is in beta, and currently only supports tasks as the triggerable resource type.

Action Parameters

Action Response

Deletes a specific attachment from asana based on its globally unique identifier (gid). this endpoint should be used when you need to permanently remove an attachment from a task or project in asana. it’s important to note that this action is irreversible - once an attachment is deleted, it cannot be recovered. this endpoint only removes the attachment from asana and does not affect the original file if it exists elsewhere. use this endpoint with caution to avoid unintended data loss.

Action Parameters

Action Response

Permanently removes a custom field from asana. this endpoint allows you to delete a specific custom field identified by its unique gid. use this when you need to eliminate a custom field that is no longer needed or was created in error. be cautious when using this endpoint, as deleting a custom field will remove it from all tasks and projects where it was previously applied, potentially affecting existing workflows and data organization. this operation cannot be undone, so it’s recommended to confirm the deletion with the user before proceeding.

Action Parameters

Action Response

Retrieves detailed information about a specific task template in asana using its unique global id (gid). this endpoint allows users to fetch the complete configuration and properties of a task template, which can be used for creating standardized tasks or setting up repeatable workflows. it’s particularly useful when you need to review or utilize an existing template’s structure before instantiating new tasks. the endpoint should be used when you have the gid of a specific task template and need its full details, such as custom fields, default assignments, or predefined task properties. it does not create or modify templates, only retrieves their information.

Action Parameters

Action Response

Retrieves the dependencies for a specific task in asana. this endpoint allows users to fetch a list of tasks that the specified task depends on, providing crucial information for project planning and task sequencing. it’s particularly useful for understanding the relationships between tasks and ensuring proper task order in complex projects. the endpoint should be used when analyzing task dependencies, planning project timelines, or before making changes to task sequences. note that this endpoint only returns the tasks that the specified task depends on, not the tasks that depend on it (dependents).

Action Parameters

Action Response

Retrieves detailed information about a specific asynchronous job in asana using its unique global id (gid). this endpoint is used to check the status, progress, or results of background processes such as bulk operations, data imports, or long-running tasks. it’s particularly useful for monitoring the progress of operations that were initiated asynchronously and may take some time to complete. the endpoint returns the current state of the job, which may include its status (e.g., pending, in progress, completed), any relevant results, or error information if the job encountered issues. use this endpoint when you need to poll for updates on a job’s progress or to confirm its completion. note that this endpoint only provides information about the job itself and does not modify or cancel the job.

Action Parameters

Action Response

Retrieves detailed information about a specific time tracking entry in asana. this endpoint allows you to fetch the complete data for a single time entry, including its duration, associated task, user who logged it, and the date it was entered. it’s useful when you need to review or verify the details of a particular time tracking record. the endpoint should be used when you have the unique identifier of a time entry and require its full information. it will not provide aggregated time data or modify the entry in any way.

Action Parameters

Action Response

Retrieves the task count statistics for a specific project in asana. this endpoint provides a summary of task-related metrics, which may include the total number of tasks, completed tasks, and other relevant counts. it is particularly useful for getting a quick overview of project progress or workload without fetching all individual tasks. use this endpoint when you need to monitor project status, generate reports, or update dashboards with current task statistics. note that this endpoint only provides aggregate counts and does not return details about individual tasks within the project.

Action Parameters

Action Response

Retrieves detailed information about a specific task in asana using its unique identifier. this endpoint allows you to fetch comprehensive data about a single task, including its title, description, assignee, due date, project associations, and other relevant metadata. it’s particularly useful when you need to access or display the current state and details of a specific task within your application or workflow. the endpoint should be used when you have a task’s gid and require its full information. note that this endpoint only provides read access to task data and cannot be used to modify the task. for real-time task updates, consider implementing webhook notifications in addition to using this endpoint.

Action Parameters

Action Response

Retrieves a list of projects within a specified asana workspace. this endpoint allows users to fetch all projects associated with a given workspace, providing an overview of the work being managed within that organizational unit. it’s particularly useful for getting a comprehensive view of ongoing work, planning resource allocation, or when integrating asana data with other systems. the endpoint returns compact project records, which include essential information about each project. it should be used when you need to enumerate or inventory projects in a workspace, but not when detailed information about a specific project is required. note that this endpoint may be subject to pagination for workspaces with a large number of projects, and additional api calls might be necessary to retrieve the complete list.

Action Parameters

Action Response

Updates an existing section within an asana project. this endpoint allows you to modify the name of a section and optionally change its position within the project structure. use this when you need to rename a section or reorganize your project layout. the endpoint requires the section’s unique identifier (gid) in the url path. you must provide a new name for the section, and you can optionally specify its new position using either ‘insert before’ or ‘insert after’ parameters, but not both. this operation is useful for maintaining an organized and up-to-date project structure in asana.

Action Parameters

Action Response

This endpoint removes a custom field setting from a specific portfolio in asana. it allows users to disassociate a custom field from a portfolio, effectively removing that field’s visibility and usage within the context of that portfolio. this action does not delete the custom field itself, but rather removes its association with the specified portfolio. use this endpoint when you need to streamline or modify the custom fields available in a particular portfolio, such as when reorganizing project structures or adjusting workflow processes. it’s important to note that this action cannot be undone through the api, so it should be used with caution. the endpoint returns information about the custom field setting that was removed, which can be useful for confirmation or logging purposes.

Action Parameters

Action Response

Retrieves detailed information about a specific portfolio membership in asana using its unique identifier. this endpoint allows you to fetch the complete data associated with a particular portfolio membership, including details such as the member’s role, permissions, and the portfolio they are associated with. it’s particularly useful when you need to access or verify the current state of a specific portfolio membership, such as checking a user’s access level or confirming their association with a portfolio. this endpoint should be used when you have the exact gid of the portfolio membership you want to examine. it does not provide information about multiple memberships or allow for querying or filtering; for those purposes, you would need to use different endpoints.

Action Parameters

Action Response

Retrieves a list of goals within a specified asana workspace. this endpoint allows users to access and review high-level objectives or targets that teams aim to achieve. it’s particularly useful for project managers and team leads who need to track progress, align tasks with broader organizational objectives, or get an overview of all active goals. the endpoint supports pagination for handling large sets of goals efficiently. note that this endpoint only provides goal metadata and basic information; it does not include detailed progress metrics or associated tasks, which may require separate api calls.

Action Parameters

Action Response

Retrieves a specific user task list from asana by its unique identifier (gid). this endpoint allows developers to fetch detailed information about a user’s task list, including associated tasks and metadata. it’s particularly useful for integrations that need to display or process a user’s tasks in external applications or workflows. the endpoint returns the current state of the task list, which may include task details, assignee information, and custom field data. use this when you need to access up-to-date information about a user’s tasks or when syncing task data with other systems. note that this endpoint only retrieves data and does not modify the task list.

Action Parameters

Action Response

Deletes a specific project status update in asana. this endpoint allows you to permanently remove a status update from a project, effectively erasing it from the project’s history. use this endpoint when you need to retract or remove an outdated or incorrect status update. it’s important to note that this action is irreversible, and once a status update is deleted, it cannot be recovered. this endpoint should be used cautiously, as it may affect project tracking and team communication. it does not affect the overall project status or any other status updates.

Action Parameters

Action Response

This endpoint removes a supporting relationship between a goal and another resource in asana. it allows users to disassociate a goal, project, task, or portfolio from a parent goal, effectively removing its contribution to the parent goal’s progress or completion. this operation is useful when restructuring goals or when a particular resource is no longer relevant to a goal’s achievement. the endpoint requires the gid of the parent goal in the url path and the gid of the supporting resource to be removed in the request body. it’s important to note that this action only removes the relationship and does not delete the supporting resource itself from asana.

Action Parameters

Action Response

Retrieves a list of workspace memberships for a specific workspace in asana. this endpoint allows you to obtain information about users associated with the workspace, including their roles and active status. it’s particularly useful for administrators or integration developers who need to manage workspace access or analyze team composition. the endpoint returns compact workspace membership objects by default, but can provide more detailed information when specified. use this endpoint when you need to audit workspace members, check user permissions, or gather data for workspace analytics. note that the response is paginated, so multiple calls may be necessary to retrieve all memberships for large workspaces.

Action Parameters

Action Response

Retrieves all stories (comments, updates, and other forms of content) associated with a specific task in asana. this endpoint is useful for fetching the complete history of interactions and updates related to a particular task. it should be used when you need to review or analyze the communication thread, progress updates, or any changes made to a task over time. the endpoint does not support filtering or sorting of stories, so it returns all stories for the specified task in chronological order. note that this endpoint does not support incremental updates or filtering by attributes like ‘created at’, which may limit its efficiency for large-scale, frequent updates.

Action Parameters

Action Response

Creates a new team within an asana organization. this endpoint allows you to set up a team with a name, description, and visibility settings. it’s used when you need to group related projects and people together for better organization and collaboration. the created team will be associated with the specified organization and will have default access control settings. note that while you can set the team’s name, description, and visibility during creation, other access control settings (like who can edit the team or manage invites) are determined by the system and cannot be set directly through this endpoint.

Action Parameters

Action Response

Retrieves a list of subtasks associated with a specific parent task in asana. this endpoint allows users to fetch all subtasks that belong to a given task, providing a hierarchical view of task organization. it’s particularly useful for projects with complex task structures or when you need to programmatically access and manage subtasks. the endpoint should be used when you need to break down a larger task into its component parts or when reviewing the detailed structure of a project. it does not create, modify, or delete subtasks; it only retrieves existing subtask information. keep in mind that the response may be paginated for tasks with a large number of subtasks, and you might need to make multiple requests to retrieve all subtasks.

Action Parameters

Action Response

Updates an existing portfolio in asana with new information. this endpoint allows you to modify specific attributes of a portfolio, such as its name, color, and visibility status. it’s particularly useful when you need to refine or adjust the properties of an existing portfolio to better reflect its current state or purpose within your project management structure. the endpoint requires the portfolio’s unique identifier (gid) and accepts a data object containing the fields to be updated. note that certain fields like members and workspace are read-only and cannot be modified through this endpoint. also, be aware that portfolios have a maximum limit of 500 items and 20 custom fields.

Action Parameters

Action Response

Permanently deletes a specific task from the asana workspace. this endpoint should be used when you want to remove a task that is no longer needed or relevant. once a task is deleted, it cannot be recovered, so use this endpoint with caution. it’s particularly useful for cleaning up completed tasks or removing tasks created in error. this operation affects all users who have access to the task and will remove it from all projects and tag associations.

Action Parameters

Action Response

Deletes a specific project brief in asana. this endpoint permanently removes the project brief identified by the provided project brief gid from the asana system. it should be used when you want to eliminate a project brief that is no longer needed or relevant. this action is irreversible, so caution should be exercised before calling this endpoint. the deletion will remove all associated content, including any rich text formatting and information contained within the brief. this endpoint is part of the project brief api, which is currently in preview and intended for development and testing purposes only.

Action Parameters

Action Response

Removes specified tasks as dependents from a given task in asana. this endpoint allows you to update task dependencies by removing one or more tasks from the list of dependents for a specific task. it’s useful for reorganizing task relationships, correcting mistakenly set dependencies, or updating project structure as work progresses. the endpoint requires the gid of the task from which dependents will be removed, and a list of gids for the tasks to be removed as dependents. it’s important to note that this operation only affects the dependency relationship and does not delete or modify the tasks themselves. use this endpoint when you need to adjust task dependencies programmatically, especially in bulk operations or automated workflow adjustments.

Action Parameters

Action Response

Updates the access level of a specific membership in an asana project or portfolio. this endpoint allows you to modify a member’s permissions by changing their access level. it’s useful for managing team roles and controlling user access within your asana workspace. use this when you need to promote or demote a member’s access rights, such as changing a commenter to an editor or vice versa. the update is applied to the membership identified by the provided membership gid. note that the ‘admin’ access level is only available for projects, not portfolios.

Action Parameters

Action Response

Creates a new status update for a specific project, portfolio, or goal in asana. this endpoint allows users to provide progress updates, share important information, and indicate the current state of the work. the status update includes text content describing the update and a status type representing the overall state. when created, the update is automatically sent to all followers of the parent object (project, portfolio, or goal). use this endpoint when you need to programmatically create status updates, such as in automated reporting systems or when integrating asana with other project management tools. it’s particularly useful for keeping stakeholders informed about project progress without manual data entry. note that while you can provide formatted text using html, the endpoint doesn’t support file attachments or direct task associations. for more complex updates or those requiring attachments, you may need to use additional asana api endpoints in conjunction with this one.

Action Parameters

Action Response

Retrieves a list of team memberships for a specific user in asana. this endpoint allows you to fetch information about which teams a particular user belongs to within the asana platform. it’s useful for understanding a user’s organizational structure, permissions, and collaborative relationships. the response typically includes details about each team the user is a member of, such as team name, role, and possibly other relevant metadata. this endpoint should be used when you need to audit a user’s team affiliations or when integrating team-based workflows that depend on knowing a user’s team memberships. note that this endpoint only provides information about existing memberships and cannot be used to modify team associations.

Action Parameters

Action Response

Creates a new portfolio in asana, providing a high-level overview for managing multiple projects or initiatives. this endpoint allows you to set up a dashboard that can track up to 500 items and 20 custom fields, offering a comprehensive view of project statuses and progress reports. use this when you need to organize and monitor multiple related projects in a centralized location. the created portfolio can be customized with a specific color and privacy setting, and will be associated with a designated workspace. note that while you define initial settings here, member management is handled separately and the members list will initially be empty.

Action Parameters

Action Response

Retrieves detailed information about a specific section within an asana project. this endpoint allows you to fetch the properties and metadata of a section using its unique identifier. use this when you need to access information about a particular section, such as its name, order within the project, or any custom fields associated with it. it’s particularly useful for applications that need to display or process section details, update section information, or verify a section’s existence. note that this endpoint only retrieves data and does not modify the section or its contents. it will not return the tasks within the section; for that, you would need to use a separate endpoint.

Action Parameters

Action Response

The updatetask endpoint allows you to modify an existing task in asana by updating its properties. this powerful tool enables you to change various aspects of a task, including its name, description, due dates, assignee, custom fields, and more. it’s particularly useful when you need to adjust task details as project requirements evolve or when updating task progress. the endpoint requires the task’s unique identifier (gid) and accepts a json object containing the fields to be updated. while it offers extensive customization, it’s important to note that some fields are read-only or have specific constraints, and certain updates may have cascading effects on related objects like projects or subtasks.

Action Parameters

Action Response

Retrieves a list of status updates for a specific project in asana. this endpoint allows you to fetch the historical progression of a project’s status, providing insights into its development over time. use this when you need to review the project’s progress, understand recent changes, or generate reports on project health. the endpoint returns status updates in chronological order, including details such as the update text, color indicator, and the time it was created. it’s particularly useful for project managers and team leads who need to track project milestones, identify potential roadblocks, or prepare for status meetings. note that this endpoint only returns status updates and does not provide detailed task information or project metadata.

Action Parameters

Action Response

Updates an existing workspace in asana with the provided information. this endpoint allows you to modify the properties of a workspace, primarily its name. it should be used when you need to rename a workspace or update its details. the endpoint requires the workspace’s globally unique identifier (gid) and accepts a json object with the updated properties. note that this operation only affects the workspace metadata and does not impact the projects, tasks, or other content within the workspace. after the update, the endpoint returns the full workspace object with all updated properties.

Action Parameters

Action Response

Adds one or more members to an existing asana project. this endpoint allows you to expand project collaboration by granting users access to view and interact with the project’s tasks and information. it’s particularly useful when onboarding new team members, reassigning projects, or setting up cross-functional collaborations. the endpoint accepts multiple user identifiers in a single request, enabling efficient bulk addition of members. note that this operation only adds members; it does not remove existing members or modify their permissions. use this endpoint when you need to programmatically manage project membership, especially in workflows involving team changes or project setup automation.

Action Parameters

Action Response

The duplicateproject endpoint creates a copy of an existing asana project with specified elements and options. it allows users to replicate project structures, tasks, and other components while providing flexibility in customizing the new project. this endpoint is particularly useful for creating templates, initiating recurring projects, or setting up similar projects across different teams. the duplication process can include various elements such as allocations, forms, members, and task details, with options to adjust dates automatically. when using this endpoint, careful consideration should be given to which elements are included and how dates are handled to ensure the new project aligns with intended timelines and team structures.

Action Parameters

Action Response

Retrieves detailed information about a specific membership within asana. this endpoint allows you to fetch comprehensive data about a user’s membership in a project, portfolio, or other asana resource, including their role and access level. use this endpoint when you need to verify or review a user’s current permissions and status within a particular asana context. it’s particularly useful for auditing user access, managing team structures, or troubleshooting permission-related issues. note that this endpoint only provides information about the specified membership and does not allow for modifications to the membership status.

Action Parameters

Action Response

This endpoint allows you to update the current value of a numerical metric for a specific goal in asana. it is used to track progress towards goal completion by setting the latest measurement of the goal’s metric. the endpoint should be called whenever there’s a new data point or measurement for the goal’s metric. it’s important to note that this endpoint is specific to goals with number-type metrics and won’t work for other metric types. the goal is identified by its unique gid, and the new metric value is provided in the request body. this endpoint is crucial for maintaining up-to-date progress information in asana’s goal tracking system.

Action Parameters

Action Response

Permanently removes a specific story from asana using its unique identifier. this endpoint should be used when you want to delete a comment, update, or any other type of story associated with a task or project in asana. it’s important to note that this action is irreversible - once a story is deleted, it cannot be recovered. only the original creator of the story has the permission to delete it. use this endpoint with caution, as it will permanently remove the story and all its associated data from the asana platform.

Action Parameters

Action Response

Retrieves detailed information about a specific workspace in asana. this endpoint allows you to fetch comprehensive data about a workspace, including its name, resource type, and other relevant details. use this endpoint when you need to access or verify workspace information, such as during initial setup, workspace management, or for displaying workspace details in your application. it’s particularly useful for applications that interact with multiple asana workspaces and need to retrieve specific workspace information programmatically. note that this endpoint only provides details about the workspace itself and does not include information about projects, tasks, or team members within the workspace.

Action Parameters

Action Response

Retrieves detailed information about a specific goal relationship in asana using its unique identifier (gid). this endpoint allows you to fetch the properties and attributes of a single goal relationship, such as the connected goals or objects, the type of relationship (e.g., supporting or blocking), and any additional metadata. use this endpoint when you need to inspect or verify the details of a particular goal relationship, especially in scenarios where you’re tracking goal dependencies or hierarchies. it’s particularly useful for applications that need to display or analyze the connections between goals in asana projects or portfolios. note that this endpoint only provides information about the relationship itself and does not modify any goal data.

Action Parameters

Action Response

Retrieves a list of all teams within a specified asana workspace that are visible to the authenticated user. this endpoint is useful for obtaining an overview of the team structure within a workspace, which can be valuable for project management and organizational purposes. it returns compact team records, providing essential information about each team. use this endpoint when you need to list teams, assign projects to teams, or understand the team hierarchy within a workspace. note that the results are limited to teams the authenticated user has permission to view, and pagination may be required for workspaces with a large number of teams.

Action Parameters

Action Response

Retrieves detailed information about a specific portfolio in asana using its unique identifier. this endpoint allows users to access comprehensive data about a portfolio, including its name, description, color, created date, and the list of projects it contains. it’s particularly useful when you need to view or analyze the current state and composition of a portfolio. the endpoint should be used when detailed portfolio information is required, such as during portfolio reviews, when updating portfolio metadata, or when integrating portfolio data with other systems. note that this endpoint only provides read access to the portfolio data and cannot be used to modify the portfolio or its contents.

Action Parameters

Action Response

Sets or updates a metric for a specific goal in asana. this endpoint allows you to create a new goal metric or modify an existing one, providing detailed information about the metric’s type, value, and how its progress is tracked. it’s particularly useful for setting up quantifiable objectives within your asana projects and tracking progress towards those objectives over time. the endpoint requires the goal’s unique identifier and accepts a comprehensive set of parameters to define the metric’s properties, including its initial, current, and target values, as well as how progress is sourced and displayed. this tool is essential for teams looking to implement data-driven goal-setting and progress tracking within their asana workflow.

Action Parameters

Action Response

Retrieves detailed information about a specific allocation in asana. this endpoint allows you to fetch the current state and attributes of an allocation, which represents the distribution of resources (such as time or effort) to tasks or projects within asana’s resource management system. use this endpoint when you need to access or review the details of a particular allocation, such as its assigned resources, time frame, or associated project. it’s particularly useful for resource planning, workload balancing, and project management activities. note that this endpoint only provides information about a single allocation and does not modify or create new allocations.

Action Parameters

Action Response

Retrieves the parent goals associated with a specific goal in asana. this endpoint allows users to fetch the higher-level objectives that a particular goal is linked to, providing insight into the goal hierarchy and organizational structure. it’s useful for understanding the context of a goal within larger strategic initiatives or for navigating up the goal tree. the endpoint returns a list of parent goal objects, which likely include details such as the parent goal’s name, due date, and progress. use this when you need to understand the broader context of a goal or when building features that visualize or navigate goal hierarchies in asana.

Action Parameters

Action Response

Deletes a specific tag from an asana workspace or organization. this endpoint allows users to permanently remove a tag, which will unlink it from all tasks it was previously associated with. use this when you want to clean up or reorganize your tag structure within asana. it’s important to note that this action is irreversible, so use it with caution. the endpoint doesn’t return the deleted tag’s information, so make sure you have the correct tag gid before proceeding with the deletion.

Action Parameters

Action Response

Updates an existing goal relationship in asana. this endpoint allows you to modify the connection between a goal and its supporting resource, which can be another goal, a project, a task, or a portfolio. use this to adjust how different elements in your workspace contribute to goal progress. you can update the supporting resource or change its contribution weight, affecting how the goal’s progress is calculated. this is particularly useful for refining goal structures, realigning priorities, or adjusting the impact of various work items on overarching objectives. note that while you can modify the supporting resource and its contribution, you cannot change the supported goal through this endpoint as it is read-only in this context.

Action Parameters

Action Response

This endpoint allows you to permanently delete a specific goal in asana. it should be used when you want to remove a goal that is no longer relevant or needed within your project or organization. the deletion is irreversible, so use this endpoint with caution. once a goal is deleted, all associated data, including progress, metrics, and relationships to other goals or tasks, will be permanently removed. this endpoint is particularly useful for cleaning up outdated goals or correcting mistakenly created goals. however, it should not be used for archiving purposes; consider updating the goal’s status instead if you want to keep a record of completed or abandoned goals.

Action Parameters

Action Response

Inserts or reorders a section within an asana project. this endpoint allows you to move an existing section to a new position in the project’s section list. you can specify the new position by indicating either the section to insert before or after. use this when you need to reorganize your project structure or change the order of sections for better workflow management. the endpoint is particularly useful for maintaining a specific order of sections in your project, which can be crucial for project organization and team coordination. note that you can only move one section at a time, and the section must already exist within the project.

Action Parameters

Action Response

Retrieves the latest status updates for projects, goals, and portfolios in asana. this endpoint allows users to fetch recent status information, including update content, timestamps, and associated entity details. it supports pagination and filtering by entity type and id, making it useful for tracking project progress, monitoring goal status, and staying informed about portfolio updates. the endpoint also provides information about likes on status updates, enhancing the social aspect of project management. use this when you need to gather the most recent status information across multiple asana entities or for a specific project, goal, or portfolio.

Action Parameters

Action Response

Updates an existing tag in asana using the provided tag gid. this endpoint allows you to modify the properties of a tag, such as its name, color, or any custom fields associated with it. use this when you need to change the metadata of a specific tag to better organize and categorize tasks within your asana workspace or organization. the endpoint replaces the entire tag resource with the data provided in the request body, so ensure all required fields are included. note that this operation cannot be used to create new tags or to modify the tag gid itself.

Action Parameters

Action Response

Creates a new goal in asana with the specified details. this endpoint allows users to set up objectives within their workspace or team, complete with descriptions, timelines, and assignments. it’s particularly useful for establishing and tracking organizational or project milestones. the created goal can be workspace-level or team-level, depending on the context and parameters provided. use this when setting up new initiatives, projects, or when breaking down larger objectives into manageable goals within asana. note that some parameters like ‘is workspace level’ and ‘team’ are conditional and depend on the workspace type (organization or not).

Action Parameters

Action Response

This endpoint deletes a specific webhook in asana using its globally unique identifier (gid). it’s used to remove a webhook when you no longer need to receive real-time notifications for the events it was set up to monitor. once deleted, the webhook will stop sending notifications to the previously configured url. this operation is permanent and cannot be undone, so use it cautiously. the endpoint is particularly useful for cleaning up unused webhooks or when you need to change your notification setup.

Action Parameters

Action Response

Removes specified members from an asana project. this endpoint allows you to revoke access for one or more users from a particular project. it’s useful for managing project team composition, especially when team members change roles or leave the organization. the endpoint requires the project’s unique identifier (gid) and a list of user identifiers to be removed. it’s important to note that this action is irreversible, and removed members will lose access to the project immediately. use this endpoint when you need to update project membership or restrict access to project information. it does not affect the users’ overall access to asana, only their membership in the specified project.

Action Parameters

Action Response

Retrieves detailed information about a specific team in asana. this endpoint allows you to fetch comprehensive data about a team, including its name, description, members, and associated projects. it’s particularly useful when you need to access or display team information within your application or when you want to verify team details before performing team-related operations. the response typically includes a compact team object, but you can request additional fields if needed. use this endpoint when you have a team’s global id (gid) and need to access its current state and properties.

Action Parameters

Action Response

Retrieves detailed information about a specific custom field in asana using its unique global id (gid). this endpoint allows developers to access the properties and configuration of a custom field, which can include its name, type (e.g., text, number, enum), and any associated options for enum fields. use this endpoint when you need to inspect or verify the settings of a particular custom field within your asana workspace or project. it’s particularly useful for applications that need to dynamically adapt to custom field configurations or display custom field information to users. note that this endpoint only provides read access to the custom field data and cannot be used to modify the field.

Action Parameters

Action Response

Deletes a specific section from an asana project. this endpoint should be used when you want to remove a section that is no longer needed or relevant. it’s important to note that the section must be empty of any tasks or attachments before deletion can occur. the operation is irreversible, so use it with caution. this tool is particularly useful for cleaning up project structures or removing temporary sections, but should not be used for archiving important project information.

Action Parameters

Action Response

Retrieves a list of items that a specific user has marked as favorites in their asana workspace. this endpoint allows you to fetch a user’s favorite tasks, projects, or other asana objects that can be favorited. the favorites are returned in the same order as they appear in asana’s sidebar. use this endpoint when you need to sync a user’s favorites across different interfaces or to provide a customized view of their most important items. note that this endpoint only retrieves the list of favorites and does not provide detailed information about each favorited item; additional api calls may be necessary to fetch complete details of the favorited objects.

Action Parameters

Action Response

Retrieves a list of portfolio memberships for a specific portfolio in asana. this endpoint allows you to fetch information about users who have access to a particular portfolio, including their roles and permissions. use this when you need to audit portfolio access, manage team members, or gather insights on portfolio collaboration. the response will include details such as user information, access levels, and membership status. note that this endpoint only provides membership data for a single portfolio at a time and does not modify any existing memberships.

Action Parameters

Action Response

Adds a specified user to an asana team. this endpoint allows you to programmatically include a user in a team, which grants them access to the team’s projects and resources. it’s particularly useful for automating onboarding processes or managing team memberships at scale. the endpoint requires the team’s global id and the user’s identification (either their asana gid, email, or ‘me’ for the authenticated user). use this when you need to expand team membership or integrate user management with external systems. note that the user being added must already have an asana account, and the authenticated user must have appropriate permissions to modify team membership.

Action Parameters

Action Response

Removes specified users from the list of followers for a given project in asana. this endpoint allows you to unsubscribe users from receiving updates about the project without affecting their membership or role within the project. it’s useful for managing notifications and reducing information overload for team members who no longer need to closely monitor a particular project. the endpoint accepts a project gid and an array of user identifiers, allowing for batch removal of multiple followers in a single api call. note that this action is reversible, and users can be added back as followers if needed.

Action Parameters

Action Response

Adds a specified user to a given asana workspace. this endpoint allows you to invite a user to join a workspace, granting them access to its projects and tasks. use this when you need to expand your team or bring in collaborators to a specific workspace. the endpoint requires the workspace’s unique identifier and the user’s identification (either as “me”, an email, or their asana gid). note that this operation doesn’t automatically accept the invitation on behalf of the user; they may still need to accept it depending on asana’s current invitation process. also, be aware that adding users might be subject to your asana plan’s limitations on the number of members per workspace.

Action Parameters

Action Response

Retrieves a list of teams that a specified user is a member of in asana. this endpoint is useful for obtaining information about a user’s team affiliations and organizational structure. it returns compact records for all teams to which the given user is assigned. use this endpoint when you need to determine which teams a particular user belongs to, which can be helpful for permission checks, team-based filtering, or understanding a user’s role within the organization. the endpoint does not provide detailed information about the teams themselves, only basic identifiers and names. note that the response may be paginated if the user belongs to a large number of teams.

Action Parameters

Action Response

Retrieves a list of workspaces accessible to the authenticated user in asana. this endpoint provides essential information about the workspaces, which are the top-level organizational units in asana where teams collaborate on projects and tasks. use this endpoint to get an overview of all workspaces the user has access to, including both personal and organizational workspaces. the response will likely include details such as workspace ids, names, and whether they are personal or organizational. this endpoint is particularly useful for applications that need to enumerate available workspaces or when implementing workspace selection functionality.

Action Parameters

Action Response

Retrieves a list of portfolios within a specified asana workspace. this endpoint allows users to access and manage their collections of projects and tasks, providing a high-level overview of work organization. it’s particularly useful for project managers and team leads who need to monitor multiple projects simultaneously. the endpoint supports pagination for handling large numbers of portfolios efficiently. while it returns basic portfolio information, detailed project data within each portfolio may require additional api calls. use this endpoint when you need to list, filter, or search through available portfolios in a workspace.

Action Parameters

Action Response

The addtaskfollowers endpoint allows you to add one or more followers to a specific task in asana. this operation is useful when you need to ensure certain team members or stakeholders are kept informed about a task’s progress without necessarily assigning them to the task. by adding followers, these users will receive notifications about updates to the task, including comments, attachments, and status changes. this endpoint should be used when you want to increase visibility and collaboration on a particular task. it’s important to note that this endpoint only adds followers and does not remove existing ones. the task gid in the url path is crucial for identifying the specific task to which followers will be added.

Action Parameters

Action Response

Creates a new project within a specified asana workspace. this endpoint allows users to set up a project with various attributes such as name, description, due date, color, and custom fields. it’s particularly useful for programmatically creating projects as part of workflow automation or when integrating asana with other systems. the endpoint returns the newly created project object, which includes all the specified attributes as well as system-generated fields like creation timestamp and project id.

Action Parameters

Action Response

Removes a specific custom field setting from a project in asana. this endpoint allows you to disassociate a custom field from a particular project, effectively removing it from the project’s task view and data structure. use this when you need to streamline a project’s custom fields or remove fields that are no longer relevant to the project’s workflow. the endpoint requires the project’s gid in the url and the custom field’s gid in the request body. note that this action only removes the custom field from the specified project; it does not delete the custom field itself from your asana workspace.

Action Parameters

Action Response

Retrieves a list of all users who are members of the specified team in asana. this endpoint is used to get detailed information about team composition, which is essential for project management, resource allocation, and team coordination. it provides a comprehensive view of all individuals associated with a particular team, allowing for better team management and collaboration. the endpoint should be used when you need to audit team membership, prepare reports on team structure, or integrate team information with other systems. note that this endpoint only returns active team members and does not include information about user roles or permissions within the team.

Action Parameters

Action Response

The list memberships endpoint retrieves information about user memberships within asana workspaces, projects, or teams. it allows you to fetch details such as user roles, access levels, and associated project or team information. this endpoint is particularly useful for administrators or managers who need to review and manage user access across their asana organization. the endpoint supports pagination for handling large sets of membership data and can be filtered by specific users if needed. use this endpoint when you need to audit user access, manage team compositions, or integrate asana membership data with other systems.

Action Parameters

Action Response

The batchrequest endpoint allows you to execute multiple asana api requests in a single http call, improving efficiency and reducing the number of individual api requests. this endpoint is particularly useful for performing related operations or when you need to make multiple api calls in sequence. it supports various http methods (get, post, put, delete, patch, head) and allows for customization of each action within the batch, including specifying relative paths, request data, and pagination options. use this endpoint when you need to optimize api usage by combining multiple operations into a single request. note that while it provides flexibility, it may not be suitable for extremely large batches of requests, and individual action responses within the batch may have different structures based on the endpoints being called.

Action Parameters

Action Response

Creates a new webhook in asana to receive notifications about changes to a specified resource. this endpoint allows you to set up automatic notifications when certain events occur in asana, such as task updates, project changes, or workspace modifications. you can use this to integrate asana with other systems, trigger automated workflows, or keep external applications in sync with asana data. the webhook can be customized using filters to receive only specific types of events, allowing for fine-grained control over the notifications you receive. this is particularly useful for large-scale integrations or when monitoring high-activity resources to reduce unnecessary network traffic.

Action Parameters

Action Response

Removes specified members from an asana portfolio. this endpoint allows you to revoke access for one or more users from a particular portfolio. it’s useful for managing team changes, project completions, or adjusting portfolio visibility. the function accepts a portfolio’s unique identifier and a list of user identifiers to be removed. it’s important to note that this action is irreversible, and removed members will lose access to the portfolio immediately. this endpoint should be used cautiously, especially when removing multiple members at once, to avoid unintended loss of access. it does not provide information about the success of individual member removals if multiple members are specified.

Action Parameters

Action Response

This endpoint allows you to add dependencies to a specific task in asana. it’s used to establish relationships between tasks where the specified task depends on the completion of other tasks. you should use this when you need to create a logical sequence of work or when certain tasks must be completed before others can start. the endpoint accepts a list of task gids to be set as dependencies for the target task. it’s important to note that while you can add multiple dependencies in a single call, asana generally limits tasks to having a combined total of 30 dependents and dependencies. this endpoint doesn’t remove existing dependencies; it only adds new ones. if you need to replace all dependencies, you should use a separate endpoint (if available) or remove existing dependencies before adding new ones.

Action Parameters

Action Response

Adds one or more members to a specified asana portfolio. this endpoint allows you to expand the team working on a particular portfolio by including new members. it’s useful when you need to grant access or assign responsibilities for projects and tasks within the portfolio to additional team members. the operation is performed by sending a post request with the list of user identifiers. note that this endpoint only adds members; it does not remove existing members or replace the entire member list. use this when you want to include new team members in a portfolio’s workflow or when restructuring team responsibilities.

Action Parameters

Action Response

The retrievetasks endpoint allows you to fetch a list of tasks from a specified asana workspace. this get request to /tasks is essential for retrieving task information, enabling applications to sync task data, generate reports, or display task lists. the endpoint supports filtering completed tasks and implements pagination for handling large result sets efficiently. it’s particularly useful for building integrations that need to keep task information up-to-date across different systems or for creating custom dashboards and reports based on asana task data. note that while this endpoint provides task retrieval functionality, it does not support creating, updating, or deleting tasks, which would require separate api calls.

Action Parameters

Action Response

Updates an existing asana project with new information. this endpoint allows you to modify various attributes of a project, such as its name, description, due date, privacy settings, and custom fields. it’s particularly useful for keeping project information up-to-date as work progresses or requirements change. the endpoint supports partial updates, meaning you only need to include the fields you want to change in the request body. note that some fields are read-only and cannot be modified through this endpoint.

Action Parameters

Action Response

Retrieves detailed information about a specific tag in asana using its unique identifier (gid). this endpoint allows you to fetch the metadata and properties associated with a particular tag, such as its name, color, and any custom fields. it’s useful when you need to access or verify the details of a tag within your asana workspace or organization. the endpoint should be used when you have the tag’s gid and require its current information. it will not provide information about tasks associated with the tag or modify the tag in any way. keep in mind that the response will only include data for tags that the authenticated user has permission to access.

Action Parameters

Action Response

Retrieves a list of all users associated with a specific workspace in asana. this endpoint is useful for obtaining information about team members, their roles, and their membership status within a particular workspace. it should be used when you need to gather user data for tasks such as managing workspace permissions, auditing team composition, or integrating user information with other systems. the endpoint returns basic user details but may not include sensitive information or extensive profile data. keep in mind that the results may be paginated for workspaces with a large number of users, and you might need to handle pagination in your application.

Action Parameters

Action Response

Creates a new allocation in asana, assigning a specific amount of time or effort for a user to work on a project. this endpoint is used to plan and distribute resources across projects, helping teams manage workloads and track time commitments. it’s particularly useful for project managers and team leads who need to schedule team members’ time across various projects. the allocation includes a start and end date, specifying the duration of the commitment, and can optionally include the effort required, either as a percentage of time or in hours. note that this endpoint creates a single allocation; for complex resource planning involving multiple team members or projects, multiple calls may be necessary.

Action Parameters

Action Response

Retrieves a list of workspace memberships for a specific user in asana. this endpoint allows you to fetch information about the workspaces a user belongs to, including their roles and permissions within each workspace. it’s useful for understanding a user’s access levels across different workspaces in an organization. the endpoint should be used when you need to audit a user’s workspace associations or when managing user permissions across multiple workspaces. note that this endpoint only provides information about the workspaces the user is a member of and does not modify any memberships.

Action Parameters

Action Response

Creates a new project brief within a specified asana project. this endpoint allows you to add a detailed description or overview of the project, helping team members understand its purpose, scope, and key information. use this when you need to establish or update the central reference document for a project. the brief can be created using either html-formatted text (preferred for rich formatting) or plain text. this tool is essential for initiating new projects or formalizing existing ones with comprehensive documentation. note that you can create only one brief per project, and subsequent calls to this endpoint for the same project will result in updating the existing brief.

Action Parameters

Action Response

Creates a new tag within a specified asana workspace. this endpoint allows you to define a tag with a name, color, description, and set of followers, which can then be used to label and categorize tasks across projects in the workspace. use this when you need to introduce a new category or label for task organization. the created tag can be immediately used for task categorization and filtering. note that tags are workspace-specific and cannot be shared across different workspaces or organizations.

Action Parameters

Action Response

This endpoint allows you to search for tasks within a specific asana workspace. it’s designed to help users find and retrieve task information efficiently, supporting complex queries and filters. use this endpoint when you need to locate specific tasks or groups of tasks based on various criteria such as assignee, due date, or custom fields. the search functionality is powerful for large workspaces with numerous tasks, enabling precise filtering and sorting. however, be aware that the search may not include tasks in projects you don’t have access to within the workspace. for real-time updates or simple task retrieval, consider using more specific task endpoints instead.

Action Parameters

Action Response

Deletes a specific project template from asana. this endpoint allows you to permanently remove a project template from your asana workspace, making it unavailable for future use in creating new projects. use this endpoint when you want to clean up outdated or unnecessary project templates. be cautious when using this endpoint, as the deletion is irreversible and will remove all associated template data. this operation is particularly useful for maintaining an organized and relevant set of project templates in your asana workspace.

Action Parameters

Action Response

Retrieves all tasks associated with a specific user task list in asana. this endpoint allows users to fetch and view their assigned tasks, helping them manage their workload efficiently. it should be used when a user needs to access their personal task list or when integrating asana task management into external applications. the endpoint returns a list of tasks, including their details such as name, due date, and status. it’s important to note that this endpoint only retrieves tasks for the specified user task list and does not provide information about tasks in other projects or shared task lists. the response may be paginated if there are many tasks, requiring multiple api calls for a complete list.

Action Parameters

Action Response

Retrieves a list of all tags available in the user’s asana workspace or project. tags are used for categorizing and organizing tasks, making it easier to filter and group related work items. this endpoint is useful when you need to get an overview of all existing tags or when you want to populate a tag selection interface in your application. the response will include details such as tag ids, names, and colors. note that this endpoint does not filter tags by project or workspace; it returns all accessible tags for the authenticated user.

Action Parameters

Action Response

The updateteam endpoint allows you to modify the attributes of an existing team in asana. this endpoint is used to update team properties such as name, description, and visibility settings. it’s particularly useful when you need to rebrand a team, update its purpose, or change its accessibility within the organization. the endpoint requires the team’s unique identifier (gid) and accepts a data object containing the attributes to be updated. while you can modify several team properties, it’s important to note that certain access level settings and the team’s organization cannot be changed through this endpoint. use this endpoint when you need to keep team information current or adjust team settings to align with organizational changes.

Action Parameters

Action Response

Retrieves a list of all project memberships for a specific asana project. this endpoint allows you to fetch information about users who have access to the project, including their roles and permission levels. use this when you need to audit project access, manage team assignments, or gather information about project participants. the response will include details such as user ids, names, and their respective access levels (e.g., admin, editor, commenter, viewer). note that this endpoint only provides information about direct project memberships and may not include inherited permissions from team memberships.

Action Parameters

Action Response

This endpoint instantiates a new project based on an existing project template in asana. it allows users to create a customized project by specifying the project name, team assignment, visibility settings, date variables, and role assignments. the function is particularly useful for teams that frequently create similar projects and want to maintain consistency while allowing for customization. it should be used when starting a new project that follows a predefined structure or workflow. the endpoint requires at least the new project’s name and can optionally include team assignment, public/private setting, date customizations, and role assignments. it does not modify the original template and does not automatically populate the new project with tasks or attachments beyond what is defined in the template.

Action Parameters

Action Response

Adds a custom field setting to a specified asana portfolio. this endpoint allows you to associate an existing custom field with a portfolio and configure its display settings within that portfolio. use this when you need to add structured, custom data fields to items in a portfolio, such as priority levels, status indicators, or any other project-specific information. the endpoint provides options for setting the field’s importance and precise positioning within the portfolio’s custom field list. it’s particularly useful for standardizing data collection across projects within a portfolio or for highlighting key information at the portfolio level.

Action Parameters

Action Response

Retrieves a list of project templates associated with a specific team in asana. this endpoint allows users to access predefined project setups, including tasks, sections, and rules, that are available for the specified team. it’s particularly useful for teams looking to standardize their project creation process or quickly set up new projects based on existing templates. the endpoint should be used when you need to view or select from available project templates for a given team, which can then be used to create new projects efficiently. note that this endpoint only provides information about the templates themselves and does not create new projects.

Action Parameters

Action Response

Creates a new project in asana with the specified attributes. this endpoint allows you to set up a project with various details such as name, description, due date, team association, and custom fields. it’s used when you need to programmatically create a new project within your asana workspace or team. the endpoint returns the full details of the created project, including its unique identifier (gid) which can be used for further operations or references.

Action Parameters

Action Response

Creates a new project status update for a specific asana project. this endpoint allows you to add a status update to a project, which will be visible to all project followers. the status update includes a title, text description, and a color code indicating the project’s overall state. while this endpoint is still functional, it’s important to note that it’s deprecated, and new integrations should prefer the ‘status update’ resource. use this when you need to provide progress updates, highlight risks, or communicate important project milestones to team members and stakeholders. the color coding feature helps quickly convey the project’s health at a glance.

Action Parameters

Action Response

This endpoint adds a custom field setting to a specific asana project. it allows you to associate an existing custom field with a project and configure its importance and position within the project’s custom field structure. use this endpoint when you need to extend a project’s data model with additional, project-specific information. the custom field must already exist in your asana workspace before it can be added to a project. you can control the field’s visibility and order within the project by using the optional parameters. note that this endpoint only adds the custom field setting to the project; it does not create new custom fields or modify existing ones.

Action Parameters

Action Response

This endpoint allows you to add followers (collaborators) to a specific goal in asana. it’s used when you want to include additional team members in the goal’s progress and updates. the endpoint requires the goal’s unique identifier (gid) and a list of users to be added as followers. it’s particularly useful for enhancing team collaboration and keeping relevant stakeholders informed about goal progress. note that this endpoint only adds followers and doesn’t remove existing ones or provide information about current followers.

Action Parameters

Action Response

Retrieves the custom field settings for a specific project in asana. this endpoint allows users to fetch the configuration of custom fields associated with a given project, providing insight into the additional data structures and fields available for tasks within that project. it’s particularly useful when you need to understand the customized data model of a project or when preparing to create or update tasks with custom fields. the endpoint returns all custom field settings for the specified project, including field types, options, and other relevant metadata. it should be used when you need a comprehensive view of a project’s custom data structure but won’t provide the actual data stored in these fields for individual tasks.

Action Parameters

Action Response

This endpoint creates a new time tracking entry for a specific task in asana. it allows users to log the duration of time spent on a task, with the option to specify the date of the entry. this tool is essential for accurate time tracking and project management within asana. use it when you need to record time spent on a task, either for the current day or a past date. the endpoint requires the task’s unique identifier and the duration in minutes, making it straightforward to integrate into time tracking workflows or automated systems.

Action Parameters

Action Response

Retrieves a list of tags associated with a specific asana workspace. this endpoint allows users to fetch compact tag records, providing an overview of all tags used within the workspace for task categorization and organization. it’s particularly useful for applications that need to synchronize tag data or build tag-based filters for tasks. the endpoint returns only basic tag information; for detailed tag data, additional api calls may be necessary. note that this endpoint doesn’t support filtering or sorting of tags in the request, so any required filtering must be done client-side.

Action Parameters

Action Response

Deletes a specific portfolio from asana based on its unique identifier. this endpoint permanently removes the portfolio and all its associated metadata from the system. it should be used when a portfolio is no longer needed or has become obsolete. this action is irreversible, so it should be used with caution. once a portfolio is deleted, all projects within it will be unlinked from the portfolio but will remain in asana. this endpoint does not return any data upon successful deletion.

Action Parameters

Action Response

Retrieves detailed information about a specific project status in asana using its unique global id (gid). this endpoint allows users to fetch the current state, attributes, and any associated metadata of a particular project status. it’s useful for monitoring project progress, updating dashboards, or syncing project status information with external systems. the endpoint should be used when you need up-to-date information about a known project status, such as its current state, color coding, or any custom fields associated with it. note that this endpoint only provides information about the status itself and not the entire project; for full project details, you would need to use a separate project-specific endpoint.

Action Parameters

Action Response

This endpoint adds an existing task to a specified project in asana. it allows for precise control over the task’s position within the project by using optional parameters to determine where the task should be inserted. the endpoint is useful for organizing work, moving tasks between projects, or adding tasks to multiple projects. it’s particularly helpful when structuring project workflows or reorganizing task priorities. note that this endpoint doesn’t create a new task; it only associates an existing task with a project. if you need to create a new task and add it to a project simultaneously, you should use a separate task creation endpoint first.

Action Parameters

Action Response

Deletes a specific task template from asana using its unique identifier (gid). this endpoint is used to permanently remove a task template that is no longer needed or relevant to your workflow. once deleted, the template cannot be recovered, and any projects or processes that relied on this template will need to be updated. use this endpoint with caution, as it will impact any automated processes or team members who regularly use the template for task creation. it’s recommended to verify that the template is truly obsolete before deletion and to communicate the change to affected team members.

Action Parameters

Action Response

Retrieves a list of sections within a specified asana project. this endpoint allows users to fetch the organizational structure of a project by returning all sections that have been created within it. it’s particularly useful for understanding the layout and categorization of tasks within a project. the endpoint should be used when you need to programmatically access or display the sections of a project, such as when building a project overview or preparing to add tasks to specific sections. note that this endpoint only returns section information and does not include the tasks within those sections. for retrieving tasks, you would need to use a separate endpoint.

Action Parameters

Action Response

Retrieves detailed information about a specific webhook in asana. this endpoint allows you to fetch the current state and configuration of a webhook, including its target url, filters, and active status. use this endpoint when you need to verify a webhook’s settings, troubleshoot notification issues, or gather information about existing webhooks. it’s particularly useful for maintaining and auditing your webhook integrations with asana. note that this endpoint only provides information about the webhook itself and does not include data about the events it has processed or will process.

Action Parameters

Action Response

Retrieves a list of portfolio memberships in asana. this endpoint allows you to fetch information about users’ memberships across one or multiple portfolios. it can be used to determine which users have access to specific portfolios and their respective roles. the endpoint supports optional filtering by portfolio or user, as well as pagination for handling large result sets. use this when you need to audit portfolio access, manage team assignments, or gather information about portfolio participation within your asana workspace. note that the response will only include portfolios and users that the authenticated user has permission to view.

Action Parameters

Action Response

This endpoint allows you to save an existing asana project as a reusable project template. it creates a new template based on the specified project’s structure, tasks, and settings. use this when you want to standardize project creation or replicate successful project setups. the endpoint requires the project’s unique identifier (gid) and allows you to set the template’s name, visibility, and location (team or workspace). it’s particularly useful for teams that frequently create similar projects or want to maintain consistency across multiple projects. note that you must choose between associating the template with a team or a workspace, as these are mutually exclusive options.

Action Parameters

Action Response

Removes a user’s membership from a specific portfolio or workspace in asana. this endpoint should be used when you need to revoke a user’s access to a particular portfolio or workspace. it’s important to note that this action is permanent and cannot be undone through the api. use this endpoint with caution, as it will immediately remove the user’s ability to access and interact with the associated portfolio or workspace. this operation does not delete the user’s account from asana entirely, but only removes their specific membership to the indicated resource.

Action Parameters

Action Response

Removes a specified user from a given asana workspace. this endpoint is used to revoke a user’s access to a workspace, which is particularly useful for managing team changes or when an employee leaves the organization. the operation requires administrative privileges in the workspace. it’s important to note that removing a user from a workspace does not delete their account from asana entirely, but only removes their access to the specific workspace. use this endpoint with caution, as it immediately terminates the user’s ability to access and collaborate on projects within the workspace.

Action Parameters

Action Response

Creates a new project within a specified team in asana. this endpoint allows you to set up a project with various attributes such as name, due date, color, custom fields, and privacy settings. it’s particularly useful for programmatically creating projects as part of team workflows or when setting up new initiatives. the created project will be associated with the team specified in the url path.

Action Parameters

Action Response

Retrieves detailed information about a specific attachment in asana using its unique identifier (gid). this endpoint allows you to fetch metadata and details of an attachment associated with a task or project in asana. use this endpoint when you need to access information about a particular attachment, such as its name, file type, size, or download url. it’s particularly useful for applications that need to display or process attachment information without downloading the entire file. note that this endpoint only provides metadata about the attachment and does not return the actual file content. to download the file, you would typically use the download url provided in the response.

Action Parameters

Action Response

Retrieves a list of tasks associated with a specific project in asana. this endpoint allows you to fetch all tasks that belong to a given project, providing a comprehensive view of the project’s workload. use this when you need to get an overview of all tasks within a project, such as for progress tracking, workload assessment, or reporting purposes. the endpoint returns basic task information; however, it may not include full details of each task, so individual task queries might be necessary for in-depth information. keep in mind that for large projects, the response may be paginated, requiring multiple requests to retrieve all tasks.

Action Parameters

Action Response

This endpoint allows you to delete a specific allocation in asana by its unique identifier. allocations represent the distribution of resources (such as time or effort) to projects or tasks. use this endpoint when you need to remove an allocation that is no longer relevant, incorrect, or needs to be adjusted. deleting an allocation will permanently remove it from the system, affecting resource management and potentially impacting project planning. be cautious when using this endpoint, as the deletion cannot be undone. it’s recommended to double-check the allocation gid before making the deletion request to ensure you’re removing the intended allocation.

Action Parameters

Action Response

Removes specified followers from a task in asana. this endpoint allows you to unsubscribe users from receiving notifications about a particular task. it’s useful for managing task visibility and reducing noise for team members who no longer need to be updated on the task’s progress. the endpoint requires the task’s unique identifier (gid) and a list of user identifiers to be removed as followers. it’s important to note that removing a follower does not affect their project membership or ability to access the task if they have appropriate permissions. use this endpoint when you need to streamline task notifications or adjust task visibility for specific users.

Action Parameters

Action Response

Retrieves a specific task from an asana workspace using a custom identifier. this endpoint is particularly useful for integrations and automations that rely on custom ids to track and manage tasks across different systems. it allows you to fetch detailed task information without needing to know asana’s internal task gid. use this endpoint when you need to retrieve task details based on a custom identifier within a specific workspace. it’s ideal for scenarios where tasks are created or updated with custom ids, such as when synchronizing tasks between asana and external project management or ticketing systems. note that this endpoint requires both the workspace gid and the task’s custom id. it will not work if either of these identifiers is incorrect or if the task with the given custom id doesn’t exist in the specified workspace. the endpoint only retrieves task information and does not modify any data.

Action Parameters

Action Response

Retrieves the user task list (my tasks view) for a specific user in asana. this endpoint allows you to access all tasks assigned to or created by the user, providing a comprehensive view of their workload. use this when you need to fetch a user’s entire task list, such as for displaying in a dashboard or syncing with another system. the endpoint returns the complete set of tasks associated with the user’s my tasks view, which may include both assigned and personal tasks. note that this endpoint does not provide filtering or sorting options; it returns the full task list as organized in asana. for more granular task retrieval or filtering, you may need to use additional endpoints or process the results client-side.

Action Parameters

Action Response

This endpoint allows you to remove a specific item from a designated portfolio in asana. it’s used when you need to update the contents of a portfolio by removing tasks, projects, or other asana entities that were previously added. the operation is performed by sending a post request to the /portfolios/{portfolio_gid}/removeitem endpoint with the item’s identifier in the request body. this tool is particularly useful for portfolio management and organization within asana, enabling programmatic updates to portfolio contents. note that this endpoint only removes the item from the portfolio; it does not delete the item from asana entirely. use this when you need to refine the scope or content of a portfolio without affecting the underlying items themselves.

Action Parameters

Action Response

Removes a specified user from a team in asana. this endpoint is used when you need to revoke a user’s membership from a particular team, effectively removing their access to team-specific projects and resources. it’s particularly useful for managing team composition, such as when a team member changes roles or leaves the organization. the endpoint requires proper authentication and authorization to execute, typically needing admin-level permissions for the team. it’s important to note that removing a user from a team does not delete their asana account or remove them from the entire workspace; it only affects their membership in the specified team.

Action Parameters

Action Response

Creates a new task in asana with the specified properties. this endpoint allows you to create a detailed task by setting various attributes such as name, description, assignee, due date, project associations, and custom fields. it’s particularly useful for programmatically creating tasks based on external triggers or as part of automated workflows. the endpoint supports creating standalone tasks, tasks within projects, and subtasks. when creating a task, you can set its initial state, including completion status and dependencies. note that some fields are create-only, meaning they can be set during creation but must be modified through separate endpoints afterward. the response will include the full details of the created task, including system-generated fields like creation timestamp and task gid.

Action Parameters

Action Response

Retrieves detailed information about a specific asana project using its unique identifier. this endpoint allows users to fetch comprehensive data about a project, including its name, description, status, due dates, team members, and associated tasks. it’s particularly useful when you need up-to-date information about a project’s current state or when integrating asana project data into external systems. the endpoint returns a single project object, providing a snapshot of the project at the time of the request. note that this endpoint does not return the full list of tasks within the project; for that, you would need to use a separate endpoint specifically for retrieving project tasks.

Action Parameters

Action Response