Sign in
Project briefs

Get a project brief

Get the full record for a project brief.

get/project_briefs/{project_brief_gid}

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/project_briefs/{project_brief_gid}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token)

Query parameters

opt_fieldsstring[]

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved the record for a project brief.

Example response

{
  "data": {
    "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"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.