Skip to content

Asana: Project briefs schemas

6 Asana schemas with complete fields and constraints.

← Project briefs operations · All schemas

Create a project brief — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringOptionalThe plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both.

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title

Get a project brief — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a project brief — response body — data data — sdk__Project Brief Response

Referenced models: Get a project brief — response body — data data — sdk__Project Brief Response

Get a project brief — response body — data data gid, html text, resource type, title

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).titlestringOptionalThe title of the project brief.
$ (allOf 2).html_textstringOptionalHTML formatted text for the project brief. See [rich text](/docs/rich-text).

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title gid, resource type

Get a project brief — response body — data data gid, html text, resource type, title gid, resource type

FieldTypePresenceDescription and constraints
$objectRootA *Project Brief* allows you to explain the what and why of the project to your team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

Get a project brief — response body — data data — Project Brief Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringOptional[Opt In](/docs/inputoutput-options). The plain text of the project brief.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).projectJSONOptional
$ (allOf 2).project (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).project (allOf 2)objectAll variants applyThe project with which this project brief is associated.

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title, Search projects in a workspace — response body — data data item

Get a project brief — response body — data data — sdk__Project Brief Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *Project Brief* allows you to explain the what and why of the project to your team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
titlestringOptionalThe title of the project brief.
html_textstringOptionalHTML formatted text for the project brief. See [rich text](/docs/rich-text).
textstringOptional[Opt In](/docs/inputoutput-options). The plain text of the project brief.
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
projectobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
The project with which this project brief is associated.
project.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
project.resource_typestringOptionalThe base type of this resource.
Read only: true
project.namestringOptionalName 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_subtypestringOptionalThe 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.
Known values: default_project, custom

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.