Skip to content

Asana: Projects schemas

25 Asana schemas with complete fields and constraints.

← Projects operations · All schemas

Add a custom field to a project — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add a custom field to a project — response body — data data — sdk__Custom Field Setting Response

Referenced models: Add a custom field to a project — response body — data data — sdk__Custom Field Setting Response

Add a custom field to a project — response body — data data custom field

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
The custom field that is applied to the `parent`.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true
enum_optionsarrayOptional*Conditional*. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to [working with enum options](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Get a custom field — response body — data data enum options item
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.
Known values: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data enum value color, enabled, gid, name, resource type
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Get a custom field — response body — data data enum options item
number_valueJSONOptional
number_value (anyOf 1)JSONAlternative
number_value (anyOf 1) (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
Read only: true
display_value (anyOf 2)nullAlternative
descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the custom field.
precisionJSONOptional
precision (anyOf 1)integerAlternativeOnly relevant for custom fields of type `Number`. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.
For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.
The identifier format will always have a precision of 0.
precision (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
formatstringOptionalThe format of this custom field.
Known values: currency, identifier, percentage, custom, duration, none
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`.
currency_code (anyOf 2)nullAlternative
custom_labelJSONOptional
custom_label (anyOf 1)stringAlternativeThis is the string that appears next to the custom field value. This will be null if the `format` is not `custom`.
custom_label (anyOf 2)nullAlternative
custom_label_positionJSONOptional
custom_label_position (anyOf 1)stringAlternativeOnly relevant for custom fields with `custom` format. This depicts where to place the custom label. This will be null if the `format` is not `custom`.
Known values: prefix, suffix
custom_label_position (anyOf 2)nullAlternative
is_global_to_workspacebooleanOptionalThis flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true.
Read only: true
has_notifications_enabledbooleanOptional*Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.
asana_created_fieldJSONOptional
asana_created_field (anyOf 1)stringAlternative*Conditional*. A unique identifier to associate this field with the template source of truth.
Known values: a_v_requirements, account_name, actionable, align_shipping_link, align_status, allotted_time, appointment, approval_stage, approved, article_series, board_committee, browser, campaign_audience, campaign_project_status, campaign_regions, channel_primary, client_topic_type, complete_by, contact, contact_email_address, content_channels, content_channels_needed, content_stage, content_type, contract, contract_status, cost, creation_stage, creative_channel, creative_needed, creative_needs, data_sensitivity, deal_size, delivery_appt, delivery_appt_date, department, department_responsible, design_request_needed, design_request_type, discussion_category, do_this_task, editorial_content_status, editorial_content_tag, editorial_content_type, effort, effort_level, est_completion_date, estimated_time, estimated_value, expected_cost, external_steps_needed, favorite_idea, feedback_type, financial, funding_amount, grant_application_process, hiring_candidate_status, idea_status, ids_link, ids_patient_link, implementation_stage, insurance, interview_area, interview_question_score, itero_scan_link, job_s_applied_to, lab, launch_status, lead_status, localization_language, localization_market_team, localization_status, meeting_minutes, meeting_needed, minutes, mrr, must_localize, name_of_foundation, need_to_follow_up, next_appointment, next_steps_sales, num_people, number_of_user_reports, office_location, onboarding_activity, owner, participants_needed, patient_date_of_birth, patient_email, patient_phone, patient_status, phone_number, planning_category, point_of_contact, position, post_format, prescription, priority, priority_level, product, product_stage, progress, project_size, project_status, proposed_budget, publish_status, reason_for_scan, referral, request_type, research_status, responsible_department, responsible_team, risk_assessment_status, room_name, sales_counterpart, sentiment, shipping_link, social_channels, stage, status, status_design, status_of_initiative, system_setup, task_progress, team, team_marketing, team_responsible, time_it_takes_to_complete_tasks, timeframe, treatment_type, type_work_requests_it, use_agency, user_name, vendor_category, vendor_type, word_count
Read only: true
asana_created_field (anyOf 2)nullAlternative
is_value_read_onlybooleanOptional*Conditional*. This flag describes whether a custom field is read only.
created_byJSONOptional
created_by (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
created_by (anyOf 2)nullAlternative
people_valuearrayOptional*Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field.
people_value[]ModelEach itemExpand Get an OOO entry — response body — data data user
reference_valuearrayOptional*Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field.
reference_value[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
reference_value[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
reference_value[].resource_typestringOptionalThe base type of this resource.
Read only: true
reference_value[].namestringOptionalThe name of the object.
html_text_valueJSONOptional
html_text_value (anyOf 1)stringAlternative*Conditional*. Only relevant for custom fields of type `text`. This is the HTML representation of the text value of a custom field, corresponding to the `text_value` plain-text field. See [rich text](/docs/rich-text#reading-rich-text).
Read only: true
html_text_value (anyOf 2)nullAlternative
privacy_settingstringOptionalThe privacy setting of the custom field. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*
Known values: public_with_guests, public, private
default_access_levelstringOptionalThe default access level when inviting new members to the custom field. This isn't applied when the `privacy_setting` is `private`, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself.
Known values: admin, editor, user
resource_subtypestringOptionalThe type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true

Referenced models: Get an OOO entry — response body — data data user, Get a custom field — response body — data data date value date, date time, Get a custom field — response body — data data enum options item, Get a custom field — response body — data data enum value color, enabled, gid, name, resource type

Add a custom field to a project — response body — data data gid, resource type

FieldTypePresenceDescription and constraints
$objectRootCustom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

Add a custom field to a project — response body — data data parent

FieldTypePresenceDescription and constraints
$objectRootA 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 parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
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

Add a custom field to a project — response body — data data project

FieldTypePresenceDescription and constraints
$objectRootA 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.
*Deprecated: new integrations should prefer the `parent` field.* The id of the project that this custom field settings refers to.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
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

Add a custom field to a project — response body — data data — Custom Field Setting Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a project — response body — data data gid, resource type
$ (allOf 2)objectAll variants apply
$ (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 apply*Deprecated: new integrations should prefer the `parent` field.* The id of the project that this custom field settings refers to.
Read only: true
$ (allOf 2).is_importantbooleanOptional`is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.
Read only: true
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).parent (allOf 2)objectAll variants applyThe parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.
Read only: true
$ (allOf 2).custom_fieldJSONOptional
$ (allOf 2).custom_field (allOf 1)ModelAll variants applyExpand Get a custom field — response body — data data — Custom Field Response
$ (allOf 2).custom_field (allOf 2)objectAll variants applyThe custom field that is applied to the `parent`.
Read only: true

Referenced models: Add a custom field to a project — response body — data data gid, resource type, Get a custom field — response body — data data — Custom Field Response, Search projects in a workspace — response body — data data item

Add a custom field to a project — response body — data data — sdk__Custom Field Setting Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
projectModelOptionalExpand Add a custom field to a project — response body — data data project
is_importantbooleanOptional`is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.
Read only: true
parentModelOptionalExpand Add a custom field to a project — response body — data data parent
custom_fieldModelOptionalExpand Add a custom field to a project — response body — data data custom field

Referenced models: Add a custom field to a project — response body — data data custom field, Add a custom field to a project — response body — data data parent, Add a custom field to a project — response body — data data project

Create a project template from a project — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the new project template.
teamstringOptionalSets the team of the new project template. If the project exists in an organization, specify team and not workspace.
workspacestringOptionalSets the workspace of the new project template. Only specify workspace if the project exists in a workspace.
publicbooleanRequired within parentSets the project template to public to its team.

Get a project — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: archived, color, completed, completed_at, completed_by, completed_by.name, created_at, created_from_template, created_from_template.name, current_status, current_status.author, current_status.author.name, current_status.color, current_status.created_at, current_status.created_by, current_status.created_by.name, current_status.html_text, current_status.modified_at, current_status.text, current_status.title, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.default_access_level, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.html_text_value, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.input_restrictions, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_lookup_field, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.privacy_setting, custom_field_settings.custom_field.reference_value, custom_field_settings.custom_field.reference_value.name, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings.custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.parent.resource_subtype, custom_field_settings.project, custom_field_settings.project.name, custom_field_settings.project.resource_subtype, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_lookup_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, default_access_level, default_view, due_date, due_on, followers, followers.name, html_notes, icon, members, members.name, minimum_access_level_for_customization, minimum_access_level_for_sharing, modified_at, name, notes, owner, permalink_url, privacy_setting, project_brief, public, resource_subtype, start_on, team, team.name, workspace, workspace.name

Get a project — response body — data

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

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

Get a project — response body — data / data / default_access_level: admin, editor, commenter, viewer, default view: list, board, calendar, timeline, minimum access level for customization: admin, editor, minimum access level for sharing: admin, editor, privacy setting: public to workspace, private to team, private, resource subtype: default project, custom

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).archivedbooleanOptionalTrue 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.
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor of the project.
Known values: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray, none
$ (allOf 2).color (anyOf 2)nullAlternative
$ (allOf 2).iconJSONOptional
$ (allOf 2).icon (anyOf 1)stringAlternativeThe icon for a project.
Known values: list, board, timeline, calendar, rocket, people, graph, star, bug, light_bulb, globe, gear, notebook, computer, check, target, html, megaphone, chat_bubbles, briefcase, page_layout, mountain_flag, puzzle, presentation, line_and_symbols, speed_dial, ribbon, shoe, shopping_basket, map, ticket, coins
$ (allOf 2).icon (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).current_statusJSONOptional
$ (allOf 2).current_status (anyOf 1)JSONAlternative
$ (allOf 2).current_status (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a project status — response body — data data — Project Status Response
$ (allOf 2).current_status (anyOf 1) (allOf 2)objectAll variants apply*Deprecated: new integrations should prefer the `current_status_update` resource.*
$ (allOf 2).current_status (anyOf 2)nullAlternative
$ (allOf 2).current_status_updateJSONOptional
$ (allOf 2).current_status_update (anyOf 1)JSONAlternative
$ (allOf 2).current_status_update (anyOf 1) (allOf 1)ModelAll variants applyExpand Get status updates from an object — response body — data, next page data item
$ (allOf 2).current_status_update (anyOf 1) (allOf 2)objectAll variants applyThe latest `status_update` posted to this project.
$ (allOf 2).current_status_update (anyOf 2)nullAlternative
$ (allOf 2).custom_field_settingsarrayOptionalArray of custom field definitions that are enabled for the project. These represent which custom fields are available to be used on tasks within the project, but do not include any values.
Read only: true
$ (allOf 2).custom_field_settings[]ModelEach itemExpand Add a custom field to a project — response body — data data — Custom Field Setting Response
$ (allOf 2).default_viewstringOptionalThe default view (list, board, calendar, or timeline) of a project.
Known values: list, board, calendar, timeline
$ (allOf 2).due_dateJSONOptional
$ (allOf 2).due_date (anyOf 1)stringAlternative*Deprecated: new integrations should prefer the `due_on` field.*
Format: date
$ (allOf 2).due_date (anyOf 2)nullAlternative
$ (allOf 2).due_onJSONOptional
$ (allOf 2).due_on (anyOf 1)stringAlternativeThe day on which this project is due. This takes a date with format YYYY-MM-DD.
Format: date
$ (allOf 2).due_on (anyOf 2)nullAlternative
$ (allOf 2).html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the project with formatting as HTML. See [rich text](/docs/rich-text).
$ (allOf 2).membersarrayOptionalArray of users who are members of this project.
Read only: true
$ (allOf 2).members[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).modified_atstringOptionalThe 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.*
Read only: true
Format: date-time
$ (allOf 2).notesstringOptionalFree-form textual information associated with the project (ie., its description).
$ (allOf 2).publicbooleanOptional*Deprecated:* new integrations use `privacy_setting` instead.
$ (allOf 2).privacy_settingstringOptionalThe privacy setting of the project. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* The value `private_to_team` is deprecated. Use `POST /memberships` to share a project with a team after creation.
Known values: public_to_workspace, private_to_team, private
$ (allOf 2).start_onJSONOptional
$ (allOf 2).start_on (anyOf 1)stringAlternativeThe 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.*
Format: date
$ (allOf 2).start_on (anyOf 2)nullAlternative
$ (allOf 2).default_access_levelstringOptionalThe default access for users or teams who join or are added as members to the project.
Known values: admin, editor, commenter, viewer
$ (allOf 2).minimum_access_level_for_customizationstringOptionalThe minimum access level needed for project members to modify this project's workflow and appearance.
Known values: admin, editor
$ (allOf 2).minimum_access_level_for_sharingstringOptionalThe minimum access level needed for project members to share the project and manage project memberships.
Known values: admin, editor

Referenced models: Add a custom field to a project — response body — data data — Custom Field Setting Response, Search projects in a workspace — response body — data data item, Get a project status — response body — data data — Project Status Response, Get status updates from an object — response body — data, next page data item, Get users in a team — response body — data data item

Get a project — response body — data data completed by gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
The user that marked this project complete, or null if the project is not completed.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

Get a project — response body — data data created from template gid, name, resource type

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time.
[Opt In](/docs/inputoutput-options). The project template from which this project was created. If the project was not created from a template, this field will be null.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project template.

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

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.A 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.
[Opt In](/docs/inputoutput-options). The project brief associated with this project.
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 — response body — data data team

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
The team that this project is shared with.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the team.

Get a project — response body — data data workspace

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
*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. If the workspace for your project is an organization, you must also supply a `team` in the request body.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project — response body — data / data / default_access_level: admin, editor, commenter, viewer, default view: list, board, calendar, timeline, minimum access level for customization: admin, editor, minimum access level for sharing: admin, editor, privacy setting: public to workspace, private to team, private, resource subtype: default project, custom
$ (allOf 2)objectAll variants apply
$ (allOf 2).custom_fieldsarrayOptionalArray of custom field values applied directly to the project itself. These represent the values set on the project, not the fields available for tasks in the project.
Read only: true
$ (allOf 2).custom_fields[]ModelEach itemExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
$ (allOf 2).completedbooleanOptionalTrue if the project is currently marked complete, false if not.
Read only: true
$ (allOf 2).completed_atJSONOptional
$ (allOf 2).completed_at (anyOf 1)stringAlternativeThe time at which this project was completed, or null if the project is not completed.
Format: date-time
Read only: true
$ (allOf 2).completed_at (anyOf 2)nullAlternative
$ (allOf 2).completed_byJSONOptional
$ (allOf 2).completed_by (anyOf 1)JSONAlternative
$ (allOf 2).completed_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).completed_by (anyOf 1) (allOf 2)JSONAll variants applyThe user that marked this project complete, or null if the project is not completed.
Read only: true
$ (allOf 2).completed_by (anyOf 2)nullAlternative
$ (allOf 2).followersarrayOptionalArray of users following this project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project.
Read only: true
$ (allOf 2).followers[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).ownerJSONOptional
$ (allOf 2).owner (anyOf 1)JSONAlternativeThe current owner of the project, may be null.
$ (allOf 2).owner (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).owner (anyOf 1) (allOf 2)objectAll variants apply
$ (allOf 2).owner (anyOf 2)nullAlternative
$ (allOf 2).teamJSONOptional
$ (allOf 2).team (allOf 1)ModelAll variants applyExpand Add a user to a team — response body — data data team — Team Compact
$ (allOf 2).team (allOf 2)objectAll variants applyThe team that this project is shared with.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).project_briefJSONOptional
$ (allOf 2).project_brief (anyOf 1)JSONAlternative
$ (allOf 2).project_brief (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
$ (allOf 2).project_brief (anyOf 1) (allOf 2)objectAll variants apply[Opt In](/docs/inputoutput-options). The project brief associated with this project.
$ (allOf 2).project_brief (anyOf 2)nullAlternative
$ (allOf 2).created_from_templateJSONOptional
$ (allOf 2).created_from_template (anyOf 1)JSONAlternative
$ (allOf 2).created_from_template (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a team's project templates — response body — data, next page data item
$ (allOf 2).created_from_template (anyOf 1) (allOf 2)objectAll variants apply[Opt In](/docs/inputoutput-options). The project template from which this project was created. If the project was not created from a template, this field will be null.
$ (allOf 2).created_from_template (anyOf 2)nullAlternative
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply*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. If the workspace for your project is an organization, you must also supply a `team` in the request body.
Read only: true
$ (allOf 2).custom_typeJSONOptional
$ (allOf 2).custom_type (anyOf 1)JSONAlternative
$ (allOf 2).custom_type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
$ (allOf 2).custom_type (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).custom_type (anyOf 2)nullAlternative

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user parent, Get a custom type — response body — data data asana created type identifier, gid, name, resource type, Get a project — response body — data / data / default_access_level: admin, editor, commenter, viewer, default view: list, board, calendar, timeline, minimum access level for customization: admin, editor, minimum access level for sharing: admin, editor, privacy setting: public to workspace, private to team, private, resource subtype: default project, custom, Get a project brief — response body — data data gid, html text, resource type, title gid, resource type, Get a team's project templates — response body — data, next page data item, Add a user to a team — response body — data data team — Team Compact, Get users in a team — response body — data data item, Update a workspace — request body — body data

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

FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
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
archivedbooleanOptionalTrue 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.
colorJSONOptional
color (anyOf 1)stringAlternativeColor of the project.
Known values: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray, none
color (anyOf 2)nullAlternative
iconJSONOptional
icon (anyOf 1)stringAlternativeThe icon for a project.
Known values: list, board, timeline, calendar, rocket, people, graph, star, bug, light_bulb, globe, gear, notebook, computer, check, target, html, megaphone, chat_bubbles, briefcase, page_layout, mountain_flag, puzzle, presentation, line_and_symbols, speed_dial, ribbon, shoe, shopping_basket, map, ticket, coins
icon (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
current_statusJSONOptional
current_status (anyOf 1)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
*Deprecated: new integrations should prefer the `status_update` resource.*
A *project status* is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: "green" for projects that are on track, "yellow" for projects at risk, and "red" for projects that are behind.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
*Deprecated: new integrations should prefer the `status_update` resource.*
A *project status* is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: "green" for projects that are on track, "yellow" for projects at risk, and "red" for projects that are behind.
*Deprecated: new integrations should prefer the `current_status_update` resource.*
current_status (anyOf 1).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
current_status (anyOf 1).resource_typestringOptionalThe base type of this resource.
Read only: true
current_status (anyOf 1).titlestringOptionalThe title of the project status update.
current_status (anyOf 1).textstringOptionalThe text content of the status update.
current_status (anyOf 1).html_textstringOptional[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text).
current_status (anyOf 1).colorstringOptionalThe color associated with the status update.
Known values: green, yellow, red, blue, complete
current_status (anyOf 1).authorModelOptionalExpand Get an OOO entry — response body — data data user
current_status (anyOf 1).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
current_status (anyOf 1).created_byModelOptionalExpand Get an OOO entry — response body — data data user
current_status (anyOf 1).modified_atstringOptionalThe time at which this project status was last modified.
*Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the project status.*
Format: date-time
Read only: true
current_status (anyOf 2)nullAlternative
current_status_updateJSONOptional
current_status_update (anyOf 1)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.
The latest `status_update` posted to this project.
current_status_update (anyOf 1).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
current_status_update (anyOf 1).resource_typestringOptionalThe base type of this resource.
Read only: true
current_status_update (anyOf 1).titlestringOptionalThe title of the status update.
current_status_update (anyOf 1).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.
The `resource_subtype`s for `status` objects represent the type of their parent.
Known values: project_status_update, portfolio_status_update, goal_status_update
Read only: true
current_status_update (anyOf 2)nullAlternative
custom_field_settingsarrayOptionalArray of custom field definitions that are enabled for the project. These represent which custom fields are available to be used on tasks within the project, but do not include any values.
Read only: true
custom_field_settings[]ModelEach itemExpand Get a goal — response body — data data custom field settings item
default_viewstringOptionalThe default view (list, board, calendar, or timeline) of a project.
Known values: list, board, calendar, timeline
due_dateJSONOptional
due_date (anyOf 1)stringAlternative*Deprecated: new integrations should prefer the `due_on` field.*
Format: date
due_date (anyOf 2)nullAlternative
due_onJSONOptional
due_on (anyOf 1)stringAlternativeThe day on which this project is due. This takes a date with format YYYY-MM-DD.
Format: date
due_on (anyOf 2)nullAlternative
html_notesstringOptional[Opt In](/docs/inputoutput-options). The notes of the project with formatting as HTML. See [rich text](/docs/rich-text).
membersarrayOptionalArray of users who are members of this project.
Read only: true
members[]ModelEach itemExpand Get an OOO entry — response body — data data user
modified_atstringOptionalThe 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.*
Read only: true
Format: date-time
notesstringOptionalFree-form textual information associated with the project (ie., its description).
publicbooleanOptional*Deprecated:* new integrations use `privacy_setting` instead.
privacy_settingstringOptionalThe privacy setting of the project. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* The value `private_to_team` is deprecated. Use `POST /memberships` to share a project with a team after creation.
Known values: public_to_workspace, private_to_team, private
start_onJSONOptional
start_on (anyOf 1)stringAlternativeThe 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.*
Format: date
start_on (anyOf 2)nullAlternative
default_access_levelstringOptionalThe default access for users or teams who join or are added as members to the project.
Known values: admin, editor, commenter, viewer
minimum_access_level_for_customizationstringOptionalThe minimum access level needed for project members to modify this project's workflow and appearance.
Known values: admin, editor
minimum_access_level_for_sharingstringOptionalThe minimum access level needed for project members to share the project and manage project memberships.
Known values: admin, editor
custom_fieldsarrayOptionalArray of custom field values applied directly to the project itself. These represent the values set on the project, not the fields available for tasks in the project.
Read only: true
custom_fields[]ModelEach itemExpand Get a goal — response body — data data custom fields item
completedbooleanOptionalTrue if the project is currently marked complete, false if not.
Read only: true
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeThe time at which this project was completed, or null if the project is not completed.
Format: date-time
Read only: true
completed_at (anyOf 2)nullAlternative
completed_byJSONOptional
completed_by (anyOf 1)ModelAlternativeExpand Get a project — response body — data data completed by gid, name, resource type
completed_by (anyOf 2)nullAlternative
followersarrayOptionalArray of users following this project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project.
Read only: true
followers[]ModelEach itemExpand Get an OOO entry — response body — data data user
ownerJSONOptional
owner (anyOf 1)JSONAlternativeThe current owner of the project, may be null.
owner (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an OOO entry — response body — data data user
owner (anyOf 1) (allOf 2)objectAll variants apply
owner (anyOf 2)nullAlternative
teamModelOptionalExpand Get a project — response body — data data team
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
project_briefJSONOptional
project_brief (anyOf 1)ModelAlternativeExpand Get a project — response body — data data project brief gid, resource type
project_brief (anyOf 2)nullAlternative
created_from_templateJSONOptional
created_from_template (anyOf 1)ModelAlternativeExpand Get a project — response body — data data created from template gid, name, resource type
created_from_template (anyOf 2)nullAlternative
workspaceModelOptionalExpand Get a project — response body — data data workspace
custom_typeJSONOptional
custom_type (anyOf 1)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent
custom_type (anyOf 2)nullAlternative

Referenced models: Get a project — response body — data data completed by gid, name, resource type, Get an OOO entry — response body — data data user, Get a project — response body — data data created from template gid, name, resource type, Get a goal — response body — data data custom fields item, Get a goal — response body — data data custom field settings item, Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent, Get a project — response body — data data project brief gid, resource type, Get a project — response body — data data team, Get a project — response body — data data workspace

Get a team's projects — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
limitintegerOptionalMinimum: 1
Maximum: 100
offsetstringOptional
archivedbooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: archived, color, completed, completed_at, completed_by, completed_by.name, created_at, created_from_template, created_from_template.name, current_status, current_status.author, current_status.author.name, current_status.color, current_status.created_at, current_status.created_by, current_status.created_by.name, current_status.html_text, current_status.modified_at, current_status.text, current_status.title, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.default_access_level, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.html_text_value, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.input_restrictions, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_lookup_field, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.privacy_setting, custom_field_settings.custom_field.reference_value, custom_field_settings.custom_field.reference_value.name, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings.custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.parent.resource_subtype, custom_field_settings.project, custom_field_settings.project.name, custom_field_settings.project.resource_subtype, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_lookup_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, default_access_level, default_view, due_date, due_on, followers, followers.name, html_notes, icon, members, members.name, minimum_access_level_for_customization, minimum_access_level_for_sharing, modified_at, name, notes, offset, owner, path, permalink_url, privacy_setting, project_brief, public, resource_subtype, start_on, team, team.name, uri, workspace, workspace.name

Get a team's projects — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a project — response body — data data — sdk__Project Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a project — response body — data data — sdk__Project Response

Get task count of a project — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get task count of a project — response body — data data

Referenced models: Get task count of a project — response body — data data

Get task count of a project — response body — data data

FieldTypePresenceDescription and constraints
$objectRootA response object returned from the task count endpoint.
num_tasksJSONOptional
num_tasks (anyOf 1)integerAlternativeThe number of tasks in a project.
num_tasks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_incomplete_tasksJSONOptional
num_incomplete_tasks (anyOf 1)integerAlternativeThe number of incomplete tasks in a project.
num_incomplete_tasks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_completed_tasksJSONOptional
num_completed_tasks (anyOf 1)integerAlternativeThe number of completed tasks in a project.
num_completed_tasks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_milestonesJSONOptional
num_milestones (anyOf 1)integerAlternativeThe number of milestones in a project.
num_milestones (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_incomplete_milestonesJSONOptional
num_incomplete_milestones (anyOf 1)integerAlternativeThe number of incomplete milestones in a project.
num_incomplete_milestones (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_completed_milestonesJSONOptional
num_completed_milestones (anyOf 1)integerAlternativeThe number of completed milestones in a project.
num_completed_milestones (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Remove followers from a project — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
followersstringRequired within parentAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.

Remove users from a project — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
membersstringRequired within parentAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.

Search projects in a workspace — response body — data data item

FieldTypePresenceDescription and constraints
$objectRootA *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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
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.
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.