Asana

Returns a list of allocations filtered to a specific project or user.

Creates a new allocation. Returns the full record of the newly created allocation.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AllocationsCreateRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The allocation to create."
}

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

Returns the complete allocation record for a single allocation.

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AllocationsUpdateRecordByIdRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the allocation."
}

Returns the compact records for all attachments on the object. There are three possible `parent` values for this request: `project`, `project_brief`, and `task`. For a project, an attachment refers to a file uploaded to the "Key resources" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to `GET /attachments` for a task will return all of the images in the task, including inline images.

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

{
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/AttachmentRequest"
      }
    }
  },
  "description": "The file you want to upload.\n\n*Note when using curl:*\n\nBe sure to add an `‘@’` before the file path, and use the `--form`\noption instead of the `-d` option.\n\nWhen uploading PDFs with curl, force the content-type to be pdf by\nappending the content type to the file path: `--form\n\"file=@file.pdf;type=application/pdf\"`."
}

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

Get the full record for a single attachment.

Retrieve the audit log events that have been captured in your domain. This endpoint will return a list of [AuditLogEvent](https://raw.githubusercontent.com) 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](https://raw.githubusercontent.com) 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](https://raw.githubusercontent.com). 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. *Note: If the filters you provided match events in your domain and `next_page` is present in the response, we will continue to send `next_page` on subsequent requests even when there are no more events that match the filters. This was put in place so that you can implement an audit log stream that will return future events that match these filters. If you are not interested in future events that match the filters you have defined, you can rely on checking empty `data` response for the end of current events that match your 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](https://raw.githubusercontent.com) 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.

Make multiple requests in parallel to Asana's API.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/BatchApiSubmitParallelRequestsRequest"
      }
    }
  },
  "required": true,
  "description": "The requests to batch together via the Batch API."
}

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

Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomFieldsCreateNewFieldRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The custom field object to create."
}

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.

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.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomFieldsUpdateFieldRecordRequest"
      }
    }
  },
  "description": "The custom field object with all updated properties."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomFieldsAddEnumOptionRequest"
      }
    }
  },
  "description": "The enum option object to create."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomFieldsReorderEnumOptionRequest"
      }
    }
  },
  "description": "The enum option object to create."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CustomFieldsUpdateEnumOptionRequest"
      }
    }
  },
  "description": "The enum option object to update"
}

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

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.*

Returns compact goal relationship records.

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

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalRelationshipsUpdateGoalRelationshipRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the goal relationship."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalRelationshipsCreateSupportingRelationshipRequest"
      }
    }
  },
  "required": true,
  "description": "The supporting resource to be added to the goal"
}

Removes a goal relationship for a given parent goal.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalRelationshipsRemoveSupportingRelationshipRequest"
      }
    }
  },
  "required": true,
  "description": "The supporting resource to be removed from the goal"
}

Returns compact goal records.

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsCreateNewGoalRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The goal to create."
}

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

Returns the complete goal record for a single goal.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsUpdateGoalRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the goal."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsAddCollaboratorsToGoalRequest"
      }
    }
  },
  "required": true,
  "description": "The followers to be added as collaborators"
}

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

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsRemoveFollowersFromGoalRequest"
      }
    }
  },
  "required": true,
  "description": "The followers to be removed as collaborators"
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsCreateMetricRequest"
      }
    }
  },
  "required": true,
  "description": "The goal metric to create."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GoalsUpdateMetricCurrentValueRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the goal metric."
}

Returns the full record for a job.

Returns compact `goal_membership` or `project_membership` records. The possible types for `parent` in this request are `goal` or `project`. An additional member (user GID or team GID) can be passed in to filter to a specific membership.

Creates a new membership in a `goal` or `project`. `Teams` or `users` can be a member of `goals` or `projects`. Returns the full record of the newly created membership.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MembershipsCreateNewRecordRequest"
      }
    }
  },
  "required": false,
  "description": "The updated fields for the membership."
}

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

Returns compact `project_membership` record for a single membership. `GET` only supports project memberships currently

An existing membership 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. Memberships on `goals` and `projects` can be updated. Returns the full record of the updated membership.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MembershipsUpdateMembershipRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The membership to update."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrganizationExportsCreateExportRequestRequest"
      }
    }
  },
  "required": true,
  "description": "The organization to export."
}

Returns details of a previously-requested Organization export.

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

Returns the complete portfolio record for a single portfolio membership.

Returns the compact portfolio membership records for the portfolio.

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

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosCreateNewPortfolioRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The portfolio to create."
}

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

Returns the complete portfolio record for a single portfolio.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosUpdatePortfolioRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the portfolio."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosAddCustomFieldSettingRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the custom field setting."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosAddPortfolioItemRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the item being inserted."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosAddMembersToPortfolioRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the members being added."
}

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

Removes a custom field setting from a portfolio.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosRemoveCustomFieldSettingRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the custom field setting being removed."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosRemoveItemFromPortfolioRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the item being removed."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortfoliosRemoveMembersFromPortfolioRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the members being removed."
}

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

Get the full record for a project brief.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectBriefsUpdateBriefRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the project brief."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectBriefsCreateNewRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The project brief to create."
}

Returns the complete project record for a single project membership.

Returns the compact project membership records for the project.

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

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

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

*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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectStatusesCreateNewStatusUpdateRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The project status to create."
}

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

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

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

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](https://raw.githubusercontent.com). 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](https://raw.githubusercontent.com) parameter._

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectTemplatesInstantiateProjectJobRequest"
      }
    }
  },
  "description": "Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables."
}

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

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!*

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsCreateNewProjectRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The project to create."
}

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

Returns the complete project record for a single project.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsUpdateProjectRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The updated fields for the project."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsAddCustomFieldSettingRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the custom field setting."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsAddFollowersToProjectRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the followers being added."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsAddMembersToProjectRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the members being added."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsDuplicateProjectJobRequest"
      }
    }
  },
  "description": "Describes the duplicate's name and the elements that will be duplicated."
}

Removes a custom field setting from a project.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsRemoveCustomFieldRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the custom field setting being removed."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsRemoveProjectFollowersRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the followers being removed."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsRemoveMembersFromProjectRequest"
      }
    }
  },
  "required": true,
  "description": "Information about the members being removed."
}

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 [this forum post](https://forum.asana.com/t/a-new-api-for-project-templates/156432).

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsCreateProjectTemplateJobRequest"
      }
    }
  },
  "required": true,
  "description": "Describes the inputs used for creating a project template, such as the resulting project template's name, which team it should be created in."
}

Get an object that holds task count fields. **All fields are excluded by default**. You must [opt in](https://raw.githubusercontent.com) using `opt_fields` to get any information from this endpoint. This endpoint has an additional [rate limit](https://raw.githubusercontent.com) and each field counts especially high against our [cost limits](/docs/rate-limits#cost-limits). Milestones are just tasks, so they are included in the `num_tasks`, `num_incomplete_tasks`, and `num_completed_tasks` counts.

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

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

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsCreateProjectForTeamRequest"
      }
    }
  },
  "required": true,
  "description": "The new project to create."
}

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.*

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProjectsCreateInWorkspaceRequest"
      }
    }
  },
  "required": true,
  "description": "The new project to create."
}

Trigger a rule which uses an ["incoming web request"](https://raw.githubusercontent.com) trigger.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/RulesTriggerRuleRequestRequest"
      }
    }
  },
  "required": true,
  "description": "A dictionary of variables accessible from within the rule."
}

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

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SectionsCreateNewSectionRequest"
      }
    }
  },
  "description": "The section to create."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SectionsMoveOrInsertRequest"
      }
    }
  },
  "description": "The section's move action."
}

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.

Returns the complete record for a single section.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SectionsUpdateSectionRecordRequest"
      }
    }
  },
  "description": "The section to create."
}

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).

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SectionsAddTaskToSectionRequest"
      }
    }
  },
  "description": "The task and optionally the insert location."
}

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

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StatusUpdatesCreateNewStatusUpdateRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The status update to create."
}

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

Returns the complete record for a single status update.

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

Returns the full record for a single story.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StoriesUpdateFullRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The comment story to update."
}

Returns the compact records for all stories on the task.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StoriesCreateCommentRequest"
      }
    }
  },
  "required": true,
  "description": "The story to create."
}

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

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TagsCreateNewTagRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The tag to create."
}

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

Returns the complete tag record for a single tag.

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.

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

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

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TagsCreateTagInWorkspaceRequest"
      }
    }
  },
  "required": true,
  "description": "The tag to create."
}

Returns the compact task template records for some filtered set of task templates. You must specify a `project`

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

Returns the complete task template record for a single task template.

Creates and returns a job that will asynchronously handle the task instantiation.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TaskTemplatesInstantiateTaskJobRequest"
      }
    }
  },
  "description": "Describes the inputs used for instantiating a task - the task's name."
}

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.

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

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

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](https://raw.githubusercontent.com).

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksCreateNewTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The task to create."
}

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.

Returns the complete task record for a single task.

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksUpdateTaskRecordRequest"
      }
    }
  },
  "required": true,
  "description": "The task to update."
}

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*.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksSetDependenciesForTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The list of tasks to set as dependencies."
}

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*.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksSetTaskDependentsRequest"
      }
    }
  },
  "required": true,
  "description": "The list of tasks to add as dependents."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksAddFollowersToTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The followers to add to the task."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksAddProjectToTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The project to add the task to."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksAddTagToTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The tag to add to the task."
}

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

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

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksDuplicateTaskJobRequest"
      }
    }
  },
  "required": true,
  "description": "Describes the duplicate's name and the fields that will be duplicated."
}

Unlinks a set of dependencies from this task.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksUnlinkDependenciesFromTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The list of tasks to unlink as dependencies."
}

Unlinks a set of dependents from this task.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksUnlinkDependentsRequest"
      }
    }
  },
  "required": true,
  "description": "The list of tasks to remove as dependents."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksRemoveFollowersFromTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The followers to remove from the task."
}

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.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksRemoveProjectFromTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The project to remove the task from."
}

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

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TasksRemoveTagFromTaskRequest"
      }
    }
  },
  "required": true,
  "description": "The tag to remove from the task."
}