Project briefs

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


ProjectBriefCompact

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.

Example JSON for ProjectBriefCompact:

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

ProjectBrief

PropertyTypeDescription
gidstringGlobally unique identifier of the resource, as a string.
resource_typestringThe base type of this resource.
titlestringThe title of the project brief.
html_textstringHTML formatted text for the project brief.
textstringOpt In. The plain text of the project brief.
permalink_urlstringA url that points directly to the object within Asana.
projectobjectThe project with which this project brief is associated.
project.gidstringGlobally unique identifier of the resource, as a string.
project.resource_typestringThe base type of this resource.
project.namestringName 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.
project.resource_subtypestringThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Click to show all enum values
  • custom
  • default_project

Example JSON for ProjectBrief:

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