Asana MCP Server

{ "server": { "url": "https://app.asana.com/api/1.0" }, "authentication": [ { "schema_parameters": { "scheme": "bearer" }, "type": "http", "value": "BEARER_TOKEN" } ], "operations": [ { "description": "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.", "name": "get_attachments_for_object" }, { "description": "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 \u0026 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 ` ` outlined [here](http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01#Basic-Rules) in order for the server to reliably and properly handle the request.", "name": "create_attachment_for_object" }, { "description": "Deletes a specific, existing attachment. Returns an empty data record.", "name": "delete_attachment" }, { "description": "Get the full record for a single attachment.", "name": "get_attachment" }, { "description": "Make multiple requests in parallel to Asana\u0027s API.", "name": "create_batch_request" }, { "description": "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\u2019s 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\u2019s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.", "name": "create_custom_field" }, { "description": "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.", "name": "delete_custom_field" }, { "description": "Get the complete definition of a custom field\u2019s 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.", "name": "get_custom_field" }, { "description": "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\u2019s `type` cannot be updated. An enum custom field\u2019s `enum_options` cannot be updated with this endpoint. Instead see \u201cWork With Enum Options\u201d 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.", "name": "update_custom_field" }, { "description": "Creates an enum option and adds it to this custom field\u2019s 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\u2019s 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.", "name": "create_enum_option_for_custom_field" }, { "description": "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.", "name": "insert_enum_option_for_custom_field" }, { "description": "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.", "name": "update_enum_option" }, { "description": "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.*", "name": "get_events" }, { "description": "Returns compact goal relationship records.", "name": "get_goal_relationships" }, { "description": "Returns the complete updated goal relationship record for a single goal relationship.", "name": "get_goal_relationship" }, { "description": "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.", "name": "update_goal_relationship" }, { "description": "Returns compact goal records.", "name": "get_goals" }, { "description": "Creates a new goal in a workspace or team. Returns the full record of the newly created goal.", "name": "create_goal" }, { "description": "A specific, existing goal can be deleted by making a DELETE request on the URL for that goal. Returns an empty data record.", "name": "delete_goal" }, { "description": "Returns the complete goal record for a single goal.", "name": "get_goal" }, { "description": "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.", "name": "update_goal" }, { "description": "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.", "name": "add_followers" }, { "description": "Creates a goal relationship by adding a supporting resource to a given goal. Returns the newly created goal relationship record.", "name": "add_supporting_relationship" }, { "description": "Returns a compact representation of all of the parent goals of a goal.", "name": "get_parent_goals_for_goal" }, { "description": "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.", "name": "remove_followers" }, { "description": "Removes a goal relationship for a given parent goal.", "name": "remove_supporting_relationship" }, { "description": "Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists.", "name": "create_goal_metric" }, { "description": "Updates a goal\u0027s existing metric\u0027s `current_number_value` if one exists, otherwise responds with a 400 status code. Returns the complete updated goal metric record.", "name": "update_goal_metric" }, { "description": "Returns the full record for a job.", "name": "get_job" }, { "description": "This method creates a request to export an Organization. Asana will complete the export at some point after you create the request.", "name": "create_organization_export" }, { "description": "Returns details of a previously-requested Organization export.", "name": "get_organization_export" }, { "description": "Returns a list of portfolio memberships in compact representation. You must specify `portfolio`, `portfolio` and `user`, or `workspace` and `user`.", "name": "get_portfolio_memberships" }, { "description": "Returns the complete portfolio record for a single portfolio membership.", "name": "get_portfolio_membership" }, { "description": "Returns a list of the portfolios in compact representation that are owned by the current API user.", "name": "get_portfolios" }, { "description": "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 \u201cPriority\u201d 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.", "name": "create_portfolio" }, { "description": "An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio. Returns an empty data record.", "name": "delete_portfolio" }, { "description": "Returns the complete portfolio record for a single portfolio.", "name": "get_portfolio" }, { "description": "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.", "name": "update_portfolio" }, { "description": "Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio.", "name": "add_custom_field_setting_for_portfolio" }, { "description": "Add an item to a portfolio. Returns an empty data block.", "name": "add_item_for_portfolio" }, { "description": "Adds the specified list of users as members of the portfolio. Returns the updated portfolio record.", "name": "add_members_for_portfolio" }, { "description": "Returns a list of all of the custom fields settings on a portfolio, in compact form.", "name": "get_custom_field_settings_for_portfolio" }, { "description": "Get a list of the items in compact form in a portfolio.", "name": "get_items_for_portfolio" }, { "description": "Returns the compact portfolio membership records for the portfolio.", "name": "get_portfolio_memberships_for_portfolio" }, { "description": "Removes a custom field setting from a portfolio.", "name": "remove_custom_field_setting_for_portfolio" }, { "description": "Remove an item from a portfolio. Returns an empty data block.", "name": "remove_item_for_portfolio" }, { "description": "Removes the specified list of users from members of the portfolio. Returns the updated portfolio record.", "name": "remove_members_for_portfolio" }, { "description": "Deletes a specific, existing project brief. Returns an empty data record.", "name": "delete_project_brief" }, { "description": "Get the full record for a project brief.", "name": "get_project_brief" }, { "description": "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.", "name": "update_project_brief" }, { "description": "Returns the complete project record for a single project membership.", "name": "get_project_membership" }, { "description": "*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Deletes a specific, existing project status update. Returns an empty data record.", "name": "delete_project_status" }, { "description": "*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Returns the complete record for a single status update.", "name": "get_project_status" }, { "description": "Returns the compact project template records for all project templates in the given team or workspace.", "name": "get_project_templates" }, { "description": "Returns the complete project template record for a single project template.", "name": "get_project_template" }, { "description": "Creates and returns a job that will asynchronously handle the project instantiation. To form this request, it is recommended to first make a request to [get a project template](/docs/get-a-project-template). Then, from the response, copy the `gid` from the object in the `requested_dates` array. This `gid` should be used in `requested_dates` to instantiate a project. _Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the [is_organization](/docs/workspace) parameter._", "name": "instantiate_project" }, { "description": "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!*", "name": "get_projects" }, { "description": "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.", "name": "create_project" }, { "description": "A specific, existing project can be deleted by making a DELETE request on the URL for that project. Returns an empty data record.", "name": "delete_project" }, { "description": "Returns the complete project record for a single project.", "name": "get_project" }, { "description": "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.", "name": "update_project" }, { "description": "Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project.", "name": "add_custom_field_setting_for_project" }, { "description": "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.", "name": "add_followers_for_project" }, { "description": "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\u0027s default notification settings (i.e., in the \"Notifcations\" tab of \"My Profile Settings\") will override this endpoint\u0027s default behavior of setting \"Tasks added\" notifications to `false`. Returns the updated project record.", "name": "add_members_for_project" }, { "description": "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 [getting started guide on input/output options](https://developers.asana.com/docs/#input-output-options) for more information.", "name": "get_custom_field_settings_for_project" }, { "description": "Creates and returns a job that will asynchronously handle the duplication.", "name": "duplicate_project" }, { "description": "Creates a new project brief. Returns the full record of the newly created project brief.", "name": "create_project_brief" }, { "description": "Returns the compact project membership records for the project.", "name": "get_project_memberships_for_project" }, { "description": "*Deprecated: new integrations should prefer the `/status_updates` route.* Returns the compact project status update records for all updates on the project.", "name": "get_project_statuses_for_project" }, { "description": "*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.", "name": "create_project_status_for_project" }, { "description": "Removes a custom field setting from a project.", "name": "remove_custom_field_setting_for_project" }, { "description": "Removes the specified list of users from following the project, this will not affect project membership status. Returns the updated project record.", "name": "remove_followers_for_project" }, { "description": "Removes the specified list of users from members of the project. Returns the updated project record.", "name": "remove_members_for_project" }, { "description": "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\u0027t be visible in the Asana UI until Project Templates 2.0 is launched in the app. See more in [this forum post](https://forum.asana.com/t/a-new-api-for-project-templates/156432).", "name": "project_save_as_template" }, { "description": "Returns the compact records for all sections in the specified project.", "name": "get_sections_for_project" }, { "description": "Creates a new section in a project. Returns the full record of the newly created section.", "name": "create_section_for_project" }, { "description": "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.", "name": "insert_section_for_project" }, { "description": "Get an object that holds task count fields. **All fields are excluded by default**. You must [opt in](/docs/input-output-options) using `opt_fields` to get any information from this endpoint. This endpoint has an additional [rate limit](/docs/standard-rate-limits) and each field counts especially high against our [cost limits](/docs/cost-limits). Milestones are just tasks, so they are included in the `num_tasks`, `num_incomplete_tasks`, and `num_completed_tasks` counts.", "name": "get_task_counts_for_project" }, { "description": "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.", "name": "get_tasks_for_project" }, { "description": "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.", "name": "delete_section" }, { "description": "Returns the complete record for a single section.", "name": "get_section" }, { "description": "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.", "name": "update_section" }, { "description": "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).", "name": "add_task_for_section" }, { "description": "*Board view only*: Returns the compact section records for all tasks within the given section.", "name": "get_tasks_for_section" }, { "description": "Returns the compact status update records for all updates on the object.", "name": "get_statuses_for_object" }, { "description": "Creates a new status update on an object. Returns the full record of the newly created status update.", "name": "create_status_for_object" }, { "description": "Deletes a specific, existing status update. Returns an empty data record.", "name": "delete_status" }, { "description": "Returns the complete record for a single status update.", "name": "get_status" }, { "description": "Deletes a story. A user can only delete stories they have created. Returns an empty data record.", "name": "delete_story" }, { "description": "Returns the full record for a single story.", "name": "get_story" }, { "description": "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.", "name": "update_story" }, { "description": "Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.", "name": "get_tags" }, { "description": "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.", "name": "create_tag" }, { "description": "A specific, existing tag can be deleted by making a DELETE request on the URL for that tag. Returns an empty data record.", "name": "delete_tag" }, { "description": "Returns the complete tag record for a single tag.", "name": "get_tag" }, { "description": "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.", "name": "update_tag" }, { "description": "Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time.", "name": "get_tasks_for_tag" }, { "description": "Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a `project` or `tag` if you do not specify `assignee` and `workspace`. For more complex task retrieval, use [workspaces/{workspace_gid}/tasks/search](/docs/search-tasks-in-a-workspace).", "name": "get_tasks" }, { "description": "Creating a new task is as easy as POSTing to the `/tasks` endpoint with a data block containing the fields you\u2019d 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.", "name": "create_task" }, { "description": "A specific, existing task can be deleted by making a DELETE request on the URL for that task. Deleted tasks go into the \u201ctrash\u201d 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.", "name": "delete_task" }, { "description": "Returns the complete task record for a single task.", "name": "get_task" }, { "description": "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.", "name": "update_task" }, { "description": "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*.", "name": "add_dependencies_for_task" }, { "description": "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*.", "name": "add_dependents_for_task" }, { "description": "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.", "name": "add_followers_for_task" }, { "description": "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.", "name": "add_project_for_task" }, { "description": "Adds a tag to a task. Returns an empty data block.", "name": "add_tag_for_task" }, { "description": "Returns the compact representations of all of the dependencies of a task.", "name": "get_dependencies_for_task" }, { "description": "Returns the compact representations of all of the dependents of a task.", "name": "get_dependents_for_task" }, { "description": "Creates and returns a job that will asynchronously handle the duplication.", "name": "duplicate_task" }, { "description": "Returns a compact representation of all of the projects the task is in.", "name": "get_projects_for_task" }, { "description": "Unlinks a set of dependencies from this task.", "name": "remove_dependencies_for_task" }, { "description": "Unlinks a set of dependents from this task.", "name": "remove_dependents_for_task" }, { "description": "Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task.", "name": "remove_follower_for_task" }, { "description": "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.", "name": "remove_project_for_task" }, { "description": "Removes a tag from a task. Returns an empty data block.", "name": "remove_tag_for_task" }, { "description": "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.", "name": "set_parent_for_task" }, { "description": "Returns the compact records for all stories on the task.", "name": "get_stories_for_task" }, { "description": "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.", "name": "create_story_for_task" }, { "description": "Returns a compact representation of all of the subtasks of a task.", "name": "get_subtasks_for_task" }, { "description": "Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask.", "name": "create_subtask_for_task" }, { "description": "Get a compact representation of all of the tags the task has.", "name": "get_tags_for_task" }, { "description": "Returns compact team membership records.", "name": "get_team_memberships" }, { "description": "Returns the complete team membership record for a single team membership.", "name": "get_team_membership" }, { "description": "Creates a team within the current workspace.", "name": "create_team" }, { "description": "Updates a team within the current workspace.", "name": "update_team" }, { "description": "Returns the full record for a single team.", "name": "get_team" }, { "description": "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.", "name": "add_user_for_team" }, { "description": "Returns the compact project template records for all project templates in the team.", "name": "get_project_templates_for_team" }, { "description": "Returns the compact project records for all projects in the team.", "name": "get_projects_for_team" }, { "description": "Creates a project shared with the given team. Returns the full record of the newly created project.", "name": "create_project_for_team" }, { "description": "The user making this call must be a member of the team in order to remove themselves or others.", "name": "remove_user_for_team" }, { "description": "Returns the compact team memberships for the team.", "name": "get_team_memberships_for_team" }, { "description": "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.", "name": "get_users_for_team" }, { "description": "Returns compact time period records.", "name": "get_time_periods" }, { "description": "Returns the full record for a single time period.", "name": "get_time_period" }, { "description": "Returns the full record for a user task list.", "name": "get_user_task_list" }, { "description": "Returns the compact list of tasks in a user\u2019s My Tasks list. *Note: Access control is enforced for this endpoint as with all Asana API endpoints, meaning a user\u2019s 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 \u201cMy Tasks\u201d in Asana.)*", "name": "get_tasks_for_user_task_list" }, { "description": "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.", "name": "get_users" }, { "description": "Returns the full user record for the single user with the provided ID.", "name": "get_user" }, { "description": "Returns all of a user\u0027s favorites in the given workspace, of the given type. Results are given in order (The same order as Asana\u0027s sidebar).", "name": "get_favorites_for_user" }, { "description": "Returns the compact team membership records for the user.", "name": "get_team_memberships_for_user" }, { "description": "Returns the compact records for all teams to which the given user is assigned.", "name": "get_teams_for_user" }, { "description": "Returns the full record for a user\u0027s task list.", "name": "get_user_task_list_for_user" }, { "description": "Returns the compact workspace membership records for the user.", "name": "get_workspace_memberships_for_user" }, { "description": "Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace.", "name": "get_webhooks" }, { "description": "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\u2019s 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. ``` # Request curl -H \"Authorization: Bearer \u003cpersonal_access_token\u003e\" -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/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/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 } } ```", "name": "create_webhook" }, { "description": "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.", "name": "delete_webhook" }, { "description": "Returns the full record for the given webhook.", "name": "get_webhook" }, { "description": "An existing webhook\u0027s filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook\u0027s previous `filters` array will be completely overwritten by the `filters` sent in the PUT request.", "name": "update_webhook" }, { "description": "Returns the complete workspace record for a single workspace membership.", "name": "get_workspace_membership" }, { "description": "Returns the compact records for all workspaces visible to the authorized user.", "name": "get_workspaces" }, { "description": "Returns the full workspace record for a single workspace.", "name": "get_workspace" }, { "description": "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.", "name": "update_workspace" }, { "description": "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.", "name": "add_user_for_workspace" }, { "description": "Retrieve the audit log events that have been captured in your domain. This endpoint will return a list of [AuditLogEvent](/docs/audit-log-event) objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results. There are a number of query parameters (below) that can be used to filter the set of [AuditLogEvent](/docs/audit-log-event) objects that are returned in the response. Any combination of query parameters is valid. When no filters are provided, all of the events that have been captured in your domain will match. The list of events will always be [paginated](/docs/pagination). The default limit is 1000 events. The next set of events can be retrieved using the `offset` from the previous response. If there are no events that match the provided filters in your domain, the 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 [AuditLogEvent](/docs/audit-log-event) 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.", "name": "get_audit_log_events" }, { "description": "Returns a list of the compact representation of all of the custom fields in a workspace.", "name": "get_custom_fields_for_workspace" }, { "description": "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.*", "name": "get_projects_for_workspace" }, { "description": "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.", "name": "create_project_for_workspace" }, { "description": "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.", "name": "remove_user_for_workspace" }, { "description": "Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.", "name": "get_tags_for_workspace" }, { "description": "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.", "name": "create_tag_for_workspace" }, { "description": "To mirror the functionality of the Asana web app\u0027s 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\u0027s 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 [pagination](https://developers.asana.com/docs/#pagination) 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\u2019re 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 [rate limits](https://developers.asana.com/docs/#rate-limits). #### 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\u0027re looking for only tasks in a section, omit the `projects.any` from the request.*", "name": "search_tasks_for_workspace" }, { "description": "Returns the compact records for all teams in the workspace visible to the authorized user.", "name": "get_teams_for_workspace" }, { "description": "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\u2019t 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\u0027s api token.", "name": "typeahead_for_workspace" }, { "description": "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.", "name": "get_users_for_workspace" }, { "description": "Returns the compact workspace membership records for the workspace.", "name": "get_workspace_memberships_for_workspace" } ] }