A project brief object represents a rich text document that describes a project.

Please note that this API is in preview, and is expected to change. This API is to be used for development and testing only as an advance view into the upcoming rich text format experience in the task description. For more information, see this post in the developer forum.

ProjectBriefCompact

A Compact object reflects the default fields returned after a successful API request. See input/output options to include more fields in the response.

Property	Type	Description
`gid`	string	Globally unique identifier of the resource, as a string.
`resource_type`	string	The base type of this resource.

{
  "gid": "12345",
  "resource_type": "project_brief"
}

ProjectBrief

Property	Type	Description
`gid`	string	Globally unique identifier of the resource, as a string.
`resource_type`	string	The base type of this resource.
`html_text`	string	HTML formatted text for the project brief.
`title`	string	The title of the project brief.
`permalink_url`	string	A url that points directly to the object within Asana.
`project`	object	The project with which this project brief is associated.
`project`.`gid`	string	Globally unique identifier of the resource, as a string.
`project`.`resource_type`	string	The base type of this resource.
`project`.`name`	string	Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
`text`	string	Opt in. The plain text of the project brief.

{
  "gid": "12345",
  "resource_type": "project_brief",
  "html_text": "<body>This is a <strong>project brief</strong>.</body>",
  "title": "Stuff to buy — Project Brief",
  "permalink_url": "https://app.asana.com/0/11111111/22222222",
  "project": {
    "gid": "12345",
    "resource_type": "project",
    "name": "Stuff to buy"
  },
  "text": "This is a project brief."
}