Asana

OpenAPI apis-guru developer_tools

This is the interface for interacting with the . Our API reference is generated from our [OpenAPI spec] ().

Homepage: https://api.apis.guru/v2/specs/asana.com/1.0.json
Provider: asana.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/asana.com/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/asana.com/1.0/openapi.yaml

Tools (169)

Extracted live via the executor SDK.

attachments.createAttachmentForObject
Upload an attachment.
This method uploads an attachment on an object and returns the compact record for the created attachment object. This is possible by either:
- Providing the URL of the external resource being attached, or
- Downloading the file content first and then uploading it as any other attachment. Note that it is not possible to attach files from third party services such as Dropbox, Box, Vimeo & Google Drive via the API
The 100MB size limit on attachments in Asana is enforced on this endpoint.
This endpoint expects a multipart/form-data encoded request containing the full contents of the file to be uploaded.
Requests made should follow the HTTP/1.1 specification that line terminators are of the form CRLF or \r\n outlined in order for the server to reliably and properly handle the request.
attachments.deleteAttachment

Deletes a specific, existing attachment.
Returns an empty data record.
attachments.getAttachment

Get the full record for a single attachment.
attachments.getAttachmentsForObject

Returns the compact records for all attachments on the object.
There are three possible parent values for this request: project, project_brief, and task. For a project, an attachment refers to a file uploaded to the "Key resources" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task.
auditLogApi.getAuditLogEvents

Retrieve the audit log events that have been captured in your domain.
This endpoint will return a list of objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results.
There are a number of query parameters (below) that can be used to filter the set of objects that are returned in the response. Any combination of query parameters is valid. When no filters are provided, all of the events that have been captured in your domain will match.
The list of events will always be . The default limit is 1000 events. The next set of events can be retrieved using the offset from the previous response. If there are no events that match the provided filters in your domain, the endpoint will return null for the next_page field. Querying again with the same filters may return new events if they were captured after the last request. Once a response includes a next_page with an offset, subsequent requests can be made with the latest offset to poll for new events that match the provided filters.
When no offset is provided, the response will begin with the oldest events that match the provided filters. It is important to note that objects will be permanently deleted from our systems after 90 days. If you wish to keep a permanent record of these events, we recommend using a SIEM tool to ingest and store these logs.
batchApi.createBatchRequest

Make multiple requests in parallel to Asana's API.
customFields.createCustomField

Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set.
A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as Due Date or Assignee. A custom field’s type must be one of text, enum, multi_enum, number, date, or people.
Returns the full record of the newly created custom field.
customFields.createEnumOptionForCustomField

Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
customFields.deleteCustomField

A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record.
customFields.getCustomField

Get the complete definition of a custom field’s metadata.
Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
customFields.getCustomFieldsForWorkspace

Returns a list of the compact representation of all of the custom fields in a workspace.
customFields.insertEnumOptionForCustomField

Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
customFields.updateCustomField

A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s type cannot be updated. An enum custom field’s enum_options cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update enum_options. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
customFields.updateEnumOption

Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
customFieldSettings.getCustomFieldSettingsForPortfolio

Returns a list of all of the custom fields settings on a portfolio, in compact form.
customFieldSettings.getCustomFieldSettingsForProject

Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, opt_fields can be used to include more data than is returned in the compact representation. See the for more information.
events.getEvents

Returns the full record for all events that have occurred since the sync token was created.
A GET request to the endpoint /[path_to_resource]/events can be made in lieu of including the resource ID in the data for the request.
Asana limits a single sync token to 100 events. If more than 100 events exist for a given resource, has_more: true will be returned in the response, indicating that there are more events to pull.
Note: The resource returned will be the resource that triggered the event. This may be different from the one that the events were requested for. For example, a subscription to a project will contain events for tasks contained within the project.
goalRelationships.addSupportingRelationship

Creates a goal relationship by adding a supporting resource to a given goal.
Returns the newly created goal relationship record.
goalRelationships.getGoalRelationship

Returns the complete updated goal relationship record for a single goal relationship.
goalRelationships.getGoalRelationships

Returns compact goal relationship records.
goalRelationships.removeSupportingRelationship

Removes a goal relationship for a given parent goal.
goalRelationships.updateGoalRelationship

An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
Returns the complete updated goal relationship record.
goals.addFollowers

Adds followers to a goal. Returns the goal the followers were added to. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
goals.createGoal

Creates a new goal in a workspace or team.
Returns the full record of the newly created goal.
goals.createGoalMetric

Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists.
goals.deleteGoal

A specific, existing goal can be deleted by making a DELETE request on the URL for that goal.
Returns an empty data record.
goals.getGoal

Returns the complete goal record for a single goal.
goals.getGoals

Returns compact goal records.
goals.getParentGoalsForGoal

Returns a compact representation of all of the parent goals of a goal.
goals.removeFollowers

Removes followers from a goal. Returns the goal the followers were removed from. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
goals.updateGoal

An existing goal can be updated by making a PUT request on the URL for that goal. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
Returns the complete updated goal record.
goals.updateGoalMetric

Updates a goal's existing metric's current_number_value if one exists, otherwise responds with a 400 status code.
Returns the complete updated goal metric record.
jobs.getJob

Returns the full record for a job.
organizationExports.createOrganizationExport

This method creates a request to export an Organization. Asana will complete the export at some point after you create the request.
organizationExports.getOrganizationExport

Returns details of a previously-requested Organization export.
portfolioMemberships.getPortfolioMembership

Returns the complete portfolio record for a single portfolio membership.
portfolioMemberships.getPortfolioMemberships

Returns a list of portfolio memberships in compact representation. You must specify portfolio, portfolio and user, or workspace and user.
portfolioMemberships.getPortfolioMembershipsForPortfolio

Returns the compact portfolio membership records for the portfolio.
portfolios.addCustomFieldSettingForPortfolio

Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio.
portfolios.addItemForPortfolio

Add an item to a portfolio. Returns an empty data block.
portfolios.addMembersForPortfolio

Adds the specified list of users as members of the portfolio. Returns the updated portfolio record.
portfolios.createPortfolio

Creates a new portfolio in the given workspace with the supplied name.
Note that portfolios created in the Asana UI may have some state (like the “Priority” custom field) which is automatically added to the portfolio when it is created. Portfolios created via our API will not be created with the same initial state to allow integrations to create their own starting state on a portfolio.
portfolios.deletePortfolio

An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio.
Returns an empty data record.
portfolios.getItemsForPortfolio

Get a list of the items in compact form in a portfolio.
portfolios.getPortfolio

Returns the complete portfolio record for a single portfolio.
portfolios.getPortfolios

Returns a list of the portfolios in compact representation that are owned by the current API user.
portfolios.removeCustomFieldSettingForPortfolio

Removes a custom field setting from a portfolio.
portfolios.removeItemForPortfolio

Remove an item from a portfolio. Returns an empty data block.
portfolios.removeMembersForPortfolio

Removes the specified list of users from members of the portfolio. Returns the updated portfolio record.
portfolios.updatePortfolio

An existing portfolio can be updated by making a PUT request on the URL for that portfolio. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
Returns the complete updated portfolio record.
projectBriefs.createProjectBrief

Creates a new project brief.
Returns the full record of the newly created project brief.
projectBriefs.deleteProjectBrief

Deletes a specific, existing project brief.
Returns an empty data record.
projectBriefs.getProjectBrief

Get the full record for a project brief.
projectBriefs.updateProjectBrief

An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
Returns the complete updated project brief record.
projectMemberships.getProjectMembership

Returns the complete project record for a single project membership.
projectMemberships.getProjectMembershipsForProject

Returns the compact project membership records for the project.
projects.addCustomFieldSettingForProject

Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project.
projects.addFollowersForProject

Adds the specified list of users as followers to the project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. Therefore, if the users are not already members of the project, they will also become members as a result of this operation. Returns the updated project record.
projects.addMembersForProject

Adds the specified list of users as members of the project. Note that a user being added as a member may also be added as a follower as a result of this operation. This is because the user's default notification settings (i.e., in the "Notifcations" tab of "My Profile Settings") will override this endpoint's default behavior of setting "Tasks added" notifications to false. Returns the updated project record.
projects.createProject

Create a new project in a workspace or team.
Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.
If the workspace for your project is an organization, you must also supply a team to share the project with.
Returns the full record of the newly created project.
projects.createProjectForTeam

Creates a project shared with the given team.
Returns the full record of the newly created project.
projects.createProjectForWorkspace

Returns the compact project records for all projects in the workspace.
If the workspace for your project is an organization, you must also supply a team to share the project with.
Returns the full record of the newly created project.
projects.deleteProject

A specific, existing project can be deleted by making a DELETE request on the URL for that project.
Returns an empty data record.
projects.duplicateProject

Creates and returns a job that will asynchronously handle the duplication.
projects.getProject

Returns the complete project record for a single project.
projects.getProjects

Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. Note: This endpoint may timeout for large domains. Try filtering by team!
projects.getProjectsForTask

Returns a compact representation of all of the projects the task is in.
projects.getProjectsForTeam

Returns the compact project records for all projects in the team.
projects.getProjectsForWorkspace

Returns the compact project records for all projects in the workspace. Note: This endpoint may timeout for large domains. Prefer the /teams/{team_gid}/projects endpoint.
projects.getTaskCountsForProject

Get an object that holds task count fields. All fields are excluded by default. You must using opt_fields to get any information from this endpoint.
This endpoint has an additional and each field counts especially high against our .
Milestones are just tasks, so they are included in the num_tasks, num_incomplete_tasks, and num_completed_tasks counts.
projects.projectSaveAsTemplate

Creates and returns a job that will asynchronously handle the project template creation. Note that while the resulting project template can be accessed with the API, it won't be visible in the Asana UI until Project Templates 2.0 is launched in the app. See more in .
projects.removeCustomFieldSettingForProject

Removes a custom field setting from a project.
projects.removeFollowersForProject

Removes the specified list of users from following the project, this will not affect project membership status. Returns the updated project record.
projects.removeMembersForProject

Removes the specified list of users from members of the project. Returns the updated project record.
projects.updateProject

A specific, existing project can be updated by making a PUT request on the URL for that project. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.
Returns the complete updated project record.
projectStatuses.createProjectStatusForProject

Deprecated: new integrations should prefer the /status_updates route.
Creates a new status update on the project.
Returns the full record of the newly created project status update.
projectStatuses.deleteProjectStatus

Deprecated: new integrations should prefer the /status_updates/{status_gid} route.
Deletes a specific, existing project status update.
Returns an empty data record.
projectStatuses.getProjectStatus

Deprecated: new integrations should prefer the /status_updates/{status_gid} route.
Returns the complete record for a single status update.
projectStatuses.getProjectStatusesForProject

Deprecated: new integrations should prefer the /status_updates route.
Returns the compact project status update records for all updates on the project.
projectTemplates.getProjectTemplate

Returns the complete project template record for a single project template.
projectTemplates.getProjectTemplates

Returns the compact project template records for all project templates in the given team or workspace.
projectTemplates.getProjectTemplatesForTeam

Returns the compact project template records for all project templates in the team.
projectTemplates.instantiateProject

Creates and returns a job that will asynchronously handle the project instantiation.
To form this request, it is recommended to first make a request to . Then, from the response, copy the gid from the object in the requested_dates array. This gid should be used in requested_dates to instantiate a project.
Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the parameter.
sections.addTaskForSection

Add a task to a specific, existing section. This will remove the task from other sections of the project.
The task will be inserted at the top of a section unless an insert_before or insert_after parameter is declared.
This does not work for separators (tasks with the resource_subtype of section).
sections.createSectionForProject

Creates a new section in a project. Returns the full record of the newly created section.
sections.deleteSection

A specific, existing section can be deleted by making a DELETE request on the URL for that section.
Note that sections must be empty to be deleted.
The last remaining section cannot be deleted.
Returns an empty data block.
sections.getSection

Returns the complete record for a single section.
sections.getSectionsForProject

Returns the compact records for all sections in the specified project.
sections.insertSectionForProject

Move sections relative to each other. One of before_section or after_section is required.
Sections cannot be moved between projects.
Returns an empty data block.
sections.updateSection

A specific, existing section can be updated by making a PUT request on the URL for that project. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the name field.)
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.
Returns the complete updated section record.
statusUpdates.createStatusForObject

Creates a new status update on an object. Returns the full record of the newly created status update.
statusUpdates.deleteStatus

Deletes a specific, existing status update.
Returns an empty data record.
statusUpdates.getStatus

Returns the complete record for a single status update.
statusUpdates.getStatusesForObject

Returns the compact status update records for all updates on the object.
stories.createStoryForTask

Adds a story to a task. This endpoint currently only allows for comment stories to be created. The comment will be authored by the currently authenticated user, and timestamped when the server receives the request.
Returns the full record for the new story added to the task.
stories.deleteStory

Deletes a story. A user can only delete stories they have created.
Returns an empty data record.
stories.getStoriesForTask

Returns the compact records for all stories on the task.
stories.getStory

Returns the full record for a single story.
stories.updateStory

Updates the story and returns the full record for the updated story. Only comment stories can have their text updated, and only comment stories and attachment stories can be pinned. Only one of text and html_text can be specified.
tags.createTag

Creates a new tag in a workspace or organization.
Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.
Returns the full record of the newly created tag.
tags.createTagForWorkspace

Creates a new tag in a workspace or organization.
Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.
Returns the full record of the newly created tag.
tags.deleteTag

A specific, existing tag can be deleted by making a DELETE request on the URL for that tag.
Returns an empty data record.
tags.getTag

Returns the complete tag record for a single tag.
tags.getTags

Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
tags.getTagsForTask

Get a compact representation of all of the tags the task has.
tags.getTagsForWorkspace

Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
tags.updateTag

Updates the properties of a tag. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the tag.
Returns the complete updated tag record.
tasks.addDependenciesForTask

Marks a set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 30 dependents and dependencies combined.
tasks.addDependentsForTask

Marks a set of tasks as dependents of this task, if they are not already dependents. A task can have at most 30 dependents and dependencies combined.
tasks.addFollowersForTask

Adds followers to a task. Returns an empty data block. Each task can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated task record, described above.
tasks.addProjectForTask

Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project.
addProject can also be used to reorder a task within a project or section that already contains it.
At most one of insert_before, insert_after, or section should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify insert_before or insert_after and a task within the section to anchor the position of this task.
Returns an empty data block.
tasks.addTagForTask

Adds a tag to a task. Returns an empty data block.
tasks.createSubtaskForTask

Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask.
tasks.createTask

Creating a new task is as easy as POSTing to the /tasks endpoint with a data block containing the fields you’d like to set on the task. Any unspecified fields will take on default values.
Every task is required to be created in a specific workspace, and this workspace cannot be changed once set. The workspace need not be set explicitly if you specify projects or a parent task instead.
tasks.deleteTask

A specific, existing task can be deleted by making a DELETE request on the URL for that task. Deleted tasks go into the “trash” of the user making the delete request. Tasks can be recovered from the trash within a period of 30 days; afterward they are completely removed from the system.
Returns an empty data record.
tasks.duplicateTask

Creates and returns a job that will asynchronously handle the duplication.
tasks.getDependenciesForTask

Returns the compact representations of all of the dependencies of a task.
tasks.getDependentsForTask

Returns the compact representations of all of the dependents of a task.
tasks.getSubtasksForTask

Returns a compact representation of all of the subtasks of a task.
tasks.getTask

Returns the complete task record for a single task.
tasks.getTasks

Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a project or tag if you do not specify assignee and workspace.
For more complex task retrieval, use .
tasks.getTasksForProject

Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time.
tasks.getTasksForSection

Board view only: Returns the compact section records for all tasks within the given section.
tasks.getTasksForTag

Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time.
tasks.getTasksForUserTaskList

Returns the compact list of tasks in a user’s My Tasks list. Note: Access control is enforced for this endpoint as with all Asana API endpoints, meaning a user’s private tasks will be filtered out if the API-authenticated user does not have access to them. Note: Both complete and incomplete tasks are returned by default unless they are filtered out (for example, setting completed_since=now will return only incomplete tasks, which is the default view for “My Tasks” in Asana.)
tasks.removeDependenciesForTask

Unlinks a set of dependencies from this task.
tasks.removeDependentsForTask

Unlinks a set of dependents from this task.
tasks.removeFollowerForTask

Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task.
tasks.removeProjectForTask

Removes the task from the specified project. The task will still exist in the system, but it will not be in the project anymore.
Returns an empty data block.
tasks.removeTagForTask

Removes a tag from a task. Returns an empty data block.

tasks.searchTasksForWorkspace

To mirror the functionality of the Asana web app's advanced search feature, the Asana API has a task search endpoint that allows you to build complex filters to find and retrieve the exact data you need.

Premium access

Like the Asana web product's advance search feature, this search endpoint will only be available to premium Asana users. A user is premium if any of the following is true:

The workspace in which the search is being performed is a premium workspace - The user is a member of a premium team inside the workspace

Even if a user is only a member of a premium team inside a non-premium workspace, search will allow them to find data anywhere in the workspace, not just inside the premium team. Making a search request using credentials of a non-premium user will result in a 402 Payment Required error.

Pagination

Search results are not stable; repeating the same query multiple times may return the data in a different order, even if the data do not change. Because of this, the traditional available elsewhere in the Asana API is not available here. However, you can paginate manually by sorting the search results by their creation time and then modifying each subsequent query to exclude data you have already seen. Page sizes are limited to a maximum of 100 items, and can be specified by the limit query parameter.

Eventual consistency

Changes in Asana (regardless of whether they’re made though the web product or the API) are forwarded to our search infrastructure to be indexed. This process can take between 10 and 60 seconds to complete under normal operation, and longer during some production incidents. Making a change to a task that would alter its presence in a particular search query will not be reflected immediately. This is also true of the advanced search feature in the web product.

Rate limits

You may receive a 429 Too Many Requests response if you hit any of our .

Custom field parameters

Parameter name	Custom field type	Accepted type
custom_fields.{gid}.is_set	All	Boolean
custom_fields.{gid}.value	Text	String
custom_fields.{gid}.value	Number	Number
custom_fields.{gid}.value	Enum	Enum option ID
custom_fields.{gid}.starts_with	Text only	String
custom_fields.{gid}.ends_with	Text only	String
custom_fields.{gid}.contains	Text only	String
custom_fields.{gid}.less_than	Number only	Number
custom_fields.{gid}.greater_than	Number only	Number

For example, if the gid of the custom field is 12345, these query parameter to find tasks where it is set would be custom_fields.12345.is_set=true. To match an exact value for an enum custom field, use the gid of the desired enum option and not the name of the enum option: custom_fields.12345.value=67890.

Not Supported: searching for multiple exact matches of a custom field, searching for multi-enum custom field

Note: If you specify projects.any and sections.any, you will receive tasks for the project and tasks for the section. If you're looking for only tasks in a section, omit the projects.any from the request.

tasks.setParentForTask

parent, or no parent task at all. Returns an empty data block. When using insert_before and insert_after, at most one of those two options can be specified, and they must already be subtasks of the parent.
tasks.updateTask

A specific, existing task can be updated by making a PUT request on the URL for that task. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.
Returns the complete updated task record.
teamMemberships.getTeamMembership

Returns the complete team membership record for a single team membership.
teamMemberships.getTeamMemberships

Returns compact team membership records.
teamMemberships.getTeamMembershipsForTeam

Returns the compact team memberships for the team.
teamMemberships.getTeamMembershipsForUser

Returns the compact team membership records for the user.
teams.addUserForTeam

The user making this call must be a member of the team in order to add others. The user being added must exist in the same organization as the team.
Returns the complete team membership record for the newly added user.
teams.createTeam

Creates a team within the current workspace.
teams.getTeam

Returns the full record for a single team.
teams.getTeamsForUser

Returns the compact records for all teams to which the given user is assigned.
teams.getTeamsForWorkspace

Returns the compact records for all teams in the workspace visible to the authorized user.
teams.removeUserForTeam

The user making this call must be a member of the team in order to remove themselves or others.
teams.updateTeam

Updates a team within the current workspace.
timePeriods.getTimePeriod

Returns the full record for a single time period.
timePeriods.getTimePeriods

Returns compact time period records.
typeahead.typeaheadForWorkspace

Retrieves objects in the workspace based via an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won’t be able to fetch large numbers of results.
The typeahead search API provides search for objects from a single workspace. This endpoint should be used to query for objects when creating an auto-completion/typeahead search feature. This API is meant to provide results quickly and should not be relied upon for accurate or exhaustive search results. The results sets are limited in size and cannot be paginated.
Queries return a compact representation of each object which is typically the gid and name fields. Interested in a specific set of fields or all of the fields?! Of course you are. Use field selectors to manipulate what data is included in a response.
Resources with type user are returned in order of most contacted to least contacted. This is determined by task assignments, adding the user to projects, and adding the user as a follower to tasks, messages, etc.
Resources with type project are returned in order of recency. This is determined when the user visits the project, is added to the project, and completes tasks in the project.
Resources with type task are returned with priority placed on tasks the user is following, but no guarantee on the order of those tasks.
Resources with type project_template are returned with priority placed on favorited project templates.
Leaving the query string empty or omitted will give you results, still following the resource ordering above. This could be used to list users or projects that are relevant for the requesting user's api token.
users.getFavoritesForUser

Returns all of a user's favorites in the given workspace, of the given type. Results are given in order (The same order as Asana's sidebar).
users.getUser

Returns the full user record for the single user with the provided ID.
users.getUsers

Returns the user records for all users in all workspaces and organizations accessible to the authenticated user. Accepts an optional workspace ID parameter. Results are sorted by user ID.
users.getUsersForTeam

Returns the compact records for all users that are members of the team. Results are sorted alphabetically and limited to 2000. For more results use the /users endpoint.
users.getUsersForWorkspace

Returns the compact records for all users in the specified workspace or organization. Results are sorted alphabetically and limited to 2000. For more results use the /users endpoint.
userTaskLists.getUserTaskList

Returns the full record for a user task list.
userTaskLists.getUserTaskListForUser

Returns the full record for a user's task list.
webhooks.createWebhook
Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource.
Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an X-Hook-Secret header. The target must respond with a 200 OK or 204 No Content and a matching X-Hook-Secret header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures.
The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook while the POST request is in-flight (in other words, have a server that can handle requests asynchronously).
Invalid hostnames like localhost will recieve a 403 Forbidden status code.
# Requestcurl -H "Authorization: Bearer <personal_access_token>" \-X POST https://app.asana.com/api/1.0/webhooks \-d "resource=8675309" \-d "target=https://example.com/receive-webhook/7654"
# Handshake sent to https://example.com/POST /receive-webhook/7654X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81
# Handshake response sent by example.comHTTP/1.1 200X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81
# ResponseHTTP/1.1 201{ "data": { "gid": "43214", "resource": { "gid": "8675309", "name": "Bugs" }, "target": "https://example.com/receive-webhook/7654", "active": false, "last_success_at": null, "last_failure_at": null, "last_failure_content": null }}
```
# Requestcurl -H "Authorization: Bearer <personal_access_token>" \-X POST https://app.asana.com/api/1.0/webhooks \-d "resource=8675309" \-d "target=https://example.com/receive-webhook/7654"
```
```
# Handshake sent to https://example.com/POST /receive-webhook/7654X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81
```
```
# Handshake response sent by example.comHTTP/1.1 200X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81
```
```
# ResponseHTTP/1.1 201{  "data": {    "gid": "43214",    "resource": {      "gid": "8675309",      "name": "Bugs"    },    "target": "https://example.com/receive-webhook/7654",    "active": false,    "last_success_at": null,    "last_failure_at": null,    "last_failure_content": null  }}
```
webhooks.deleteWebhook

This method permanently removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued.
webhooks.getWebhook

Returns the full record for the given webhook.
webhooks.getWebhooks

Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace.
webhooks.updateWebhook

An existing webhook's filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook's previous filters array will be completely overwritten by the filters sent in the PUT request.
workspaceMemberships.getWorkspaceMembership

Returns the complete workspace record for a single workspace membership.
workspaceMemberships.getWorkspaceMembershipsForUser

Returns the compact workspace membership records for the user.
workspaceMemberships.getWorkspaceMembershipsForWorkspace

Returns the compact workspace membership records for the workspace.
workspaces.addUserForWorkspace

Add a user to a workspace or organization. The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user.
workspaces.getWorkspace

Returns the full workspace record for a single workspace.
workspaces.getWorkspaces

Returns the compact records for all workspaces visible to the authorized user.
workspaces.removeUserForWorkspace

Remove a user from a workspace or organization. The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address. Returns an empty data record.
workspaces.updateWorkspace

A specific, existing workspace can be updated by making a PUT request on the URL for that workspace. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. Currently the only field that can be modified for a workspace is its name. Returns the complete, updated workspace record.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools