Get a project

Returns the complete project record for a single project.

{ "data": { "gid": "12345", "resource_type": "task", "name": "Stuff to buy", "archived": false, "color": "light-green", "created_at": "2012-02-22T02:06:58.147Z", "current_status": { "gid": "12345", "resource_type": "task", "title": "Status Update - Jun 15", "color": "green", "html_text": "<body>The project <strong>is</strong> moving forward according to plan...</body>", "text": "The project is moving forward according to plan...", "author": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" }, "created_at": "2012-02-22T02:06:58.147Z", "created_by": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" }, "modified_at": "2012-02-22T02:06:58.147Z" }, "custom_field_settings": [ { "gid": "12345", "resource_type": "task" } ], "default_view": "calendar", "due_date": "2019-09-15", "due_on": "2019-09-15", "html_notes": "<body>These are things we need to purchase.</body>", "is_template": false, "members": [ { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } ], "modified_at": "2012-02-22T02:06:58.147Z", "notes": "These are things we need to purchase.", "public": false, "start_on": "2019-09-14", "workspace": { "gid": "12345", "resource_type": "task", "name": "My Company Workspace" }, "custom_fields": [ { "gid": "12345", "resource_type": "task", "display_value": "blue", "enabled": true, "enum_options": [ { "gid": "12345", "resource_type": "task", "color": "blue", "enabled": true, "name": "Low" } ], "name": "Status", "number_value": 5.2, "resource_subtype": "text", "text_value": "Some Value", "type": "text" } ], "followers": [ { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } ], "icon": "chat_bubbles", "owner": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" }, "permalink_url": "https://app.asana.com/0/resource/123456789/list", "team": { "gid": "12345", "resource_type": "task", "name": "Marketing" } } }

Responses

🟢200Successfully retrieved the requested project.

application/json

Body

data

object (ProjectResponse)

optional

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.

custom_fields

array[object (CustomFieldCompact) {10}]

read-onlyoptional

Array of Custom Fields.

followers

array[object (UserCompact) {3}]

read-onlyoptional

Array of users following this project. Followers are a subset of members who receive all notifications for a project, the default notification setting when adding members to a project in-product.

icon

enum<string> | enum<null>

optional

The icon for a project.

Allowed values:

listboardtimelinecalendarrocketpeoplegraphstarbuglight_bulbglobegearnotebookcomputerchecktargethtmlmegaphonechat_bubblesbriefcasepage_layoutmountain_flagpuzzlepresentationline_and_symbolsspeed_dialribbonshoeshopping_basketmapticketcoins

Example:

chat_bubbles

owner

null | allOf {1}

optional

The current owner of the project, may be null.

permalink_url

string

read-onlyoptional

A url that points directly to the object within Asana.

Example:

https://app.asana.com/0/resource/123456789/list

team

object

optional

Create-only. The team that this project is shared with. This field only exists for projects in organizations.

archived

boolean

optional

True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.

Example:

false

color

enum<string> | enum<null>

optional

Color of the project.

Allowed values:

dark-pinkdark-greendark-bluedark-reddark-tealdark-browndark-orangedark-purpledark-warm-graylight-pinklight-greenlight-bluelight-redlight-teallight-brownlight-orangelight-purplelight-warm-gray

Example:

light-green

created_at

string <date-time>

read-onlyoptional

The time at which this resource was created.

Example:

2012-02-22T02:06:58.147Z

current_status

null | allOf {1}

optional

custom_field_settings

array[object (CustomFieldSettingCompact) {2}]

read-onlyoptional

Array of Custom Field Settings (in compact form).

default_view

enum<string>

optional

The default view (list, board, calendar, or timeline) of a project.

Allowed values:

listboardcalendartimeline

Example:

calendar

due_date

string <date-time> | null

optional

Deprecated: new integrations should prefer the due_on field.

Example:

2019-09-15

due_on

string <date-time> | null

optional

The day on which this project is due. This takes a date with format YYYY-MM-DD.

Example:

2019-09-15

html_notes

string

optional

Opt In. The notes of the project with formatting as HTML.

Example:

<body>These are things we need to purchase.</body>

is_template

boolean

optional

Opt In. Determines if the project is a template.

Example:

false

members

array[object (UserCompact) {3}]

read-onlyoptional

Array of users who are members of this project.

modified_at

string <date-time>

read-onlyoptional

The time at which this project was last modified.
Note: This does not currently reflect any changes in associations such as tasks or comments that may have been added or removed from the project.

Example:

2012-02-22T02:06:58.147Z

notes

string

optional

Free-form textual information associated with the project (ie., its description).

Example:

These are things we need to purchase.

public

boolean

optional

True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.

Example:

false

start_on

string <date> | null

optional

The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format. Note: due_on or due_at must be present in the request when setting or unsetting the start_on parameter. Additionally, start_on and due_on cannot be the same date.

Example:

2019-09-14

workspace

object

read-onlyoptional

Create-only. The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

name

string

optional

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.

Example:

Stuff to buy

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Get a project

Request

Responses