Sample - Asana API
GET/project_briefs/{project_brief_gid}

Get a project brief

Retrieves the full record for a project brief. Use opt_fields to request selected properties, including project details, text, title, or the brief's permalink. The response contains the project brief resource.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
opt_fieldsarray<string>optional
A comma-separated selection of project brief properties to include in the response, including `html_text`, `permalink_url`, `project`, `project.name`, `text`, or `title`. Omit it to use the default response fields.

11 status codes
200Returns the project brief record in the `data` object, including any properties selected through `opt_fields`.
dataobjectoptional
400Returned when the request or `opt_fields` selection is malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
402Returned when the requested project brief or operation exceeds the current premium level.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the project brief.
errorsarray<object>optional
404Returned when the project brief does not exist, or the method and path do not identify a known action.
errorsarray<object>optional
424Returned when an enforced API rate limit has been exceeded.
errorsarray<object>optional
500Returned when the API encounters a server-side failure.
errorsarray<object>optional
501Returned when there is an issue between the load balancers and the API.
errorsarray<object>optional
503Returned when an upstream service is unavailable or the API has been intentionally shut off.
errorsarray<object>optional
504Returned when the request takes too long to complete.
errorsarray<object>optional

Error handling

A 400 is returned when the request or opt_fields selection is malformed. A 401 indicates that no valid authentication token was provided, while a 402 indicates that the requested object or operation exceeds the current premium level. A 403 indicates insufficient access, a 404 indicates that the project brief does not exist, and a 424 indicates that an enforced rate limit was exceeded. A 500, 501, 503, or 504 indicates a server or service failure, an intermediary issue, an unavailable upstream service, or a request timeout respectively.