Asana: Portfolios schemas
12 Asana schemas with complete fields and constraints.
← Portfolios operations · All schemas
Add a portfolio item — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
item | string | Required within parent | The item to add to the portfolio. |
insert_before | string | Optional | An id of an item in this portfolio. The new item will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. |
insert_after | string | Optional | An id of an item in this portfolio. The new item will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. |
Get a portfolio — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One of: archived, color, created_at, created_by, created_by.name, 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, due_on, members, members.name, name, owner, owner.name, permalink_url, privacy_setting, project_templates, project_templates.name, public, resource_subtype, start_on, workspace, workspace.name |
Get a portfolio — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a portfolio — response body — data data — sdk__Portfolio Response |
Referenced models: Get a portfolio — response body — data data — sdk__Portfolio Response
Get a portfolio — response body — data / data / default_access_level: admin, editor, viewer, resource subtype: default portfolio, custom
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).archived | boolean | Optional | [Opt In](/docs/inputoutput-options). True if the portfolio is archived, false if not. Archived portfolios do not show in the UI by default and may be treated differently for queries. |
$ (allOf 2).color | string | Optional | Color of the portfolio. 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 |
$ (allOf 2).start_on | JSON | Optional | |
$ (allOf 2).start_on (anyOf 1) | string | Alternative | The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` 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) | null | Alternative | |
$ (allOf 2).due_on | JSON | Optional | |
$ (allOf 2).due_on (anyOf 1) | string | Alternative | The day on which this portfolio is due. This takes a date with format YYYY-MM-DD. Format: date |
$ (allOf 2).due_on (anyOf 2) | null | Alternative | |
$ (allOf 2).default_access_level | string | Optional | The default access level when inviting new members to the portfolio Known values: admin, editor, viewer |
$ (allOf 2).public | boolean | Optional | Defines whether the portfolio is public to its workspace members. `true` if the portfolio is public to workspace members, `false` if it's visible only to members of the portfolio. New portfolios are private by default. |
Referenced models: Get a portfolio membership — response body — data data portfolio — Portfolio Compact
Get a portfolio — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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 that the portfolio belongs to. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get a portfolio — response body — data data — Portfolio Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a portfolio — response body — data / data / default_access_level: admin, editor, viewer, resource subtype: default portfolio, custom |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).created_by | Model | Optional | Expand Get users in a team — response body — data data item |
$ (allOf 2).custom_field_settings | array | Optional | Array of custom field definitions that are enabled for the portfolio. These represent which custom fields are available to be used on items within the portfolio, but do not include any values. |
$ (allOf 2).custom_field_settings[] | Model | Each item | Expand Add a custom field to a project — response body — data data — Custom Field Setting Response |
$ (allOf 2).current_status_update | JSON | Optional | |
$ (allOf 2).current_status_update (anyOf 1) | JSON | Alternative | |
$ (allOf 2).current_status_update (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get status updates from an object — response body — data, next page data item |
$ (allOf 2).current_status_update (anyOf 1) (allOf 2) | JSON | All variants apply | The latest `status_update` posted to this portfolio. |
$ (allOf 2).current_status_update (anyOf 2) | null | Alternative | |
$ (allOf 2).custom_fields | array | Optional | Array of custom field values applied directly to the portfolio itself. These represent the values set on the portfolio, not the fields available for items in the portfolio. |
$ (allOf 2).custom_fields[] | Model | Each item | Expand Get a membership — response body — data / data / access_level: admin, editor, user parent |
$ (allOf 2).members | array | Optional | Read only: true |
$ (allOf 2).members[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).owner | Model | Optional | Expand Get users in a team — response body — data data item |
$ (allOf 2).workspace | JSON | Optional | |
$ (allOf 2).workspace (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).workspace (allOf 2) | object | All variants apply | *Create-only*. The workspace or organization that the portfolio belongs to. |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).privacy_setting | string | Optional | The privacy setting of the portfolio. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* Known values: public_to_domain, members_only |
$ (allOf 2).project_templates | array | Optional | Array of project templates that are in the portfolio Read only: true |
$ (allOf 2).project_templates[] | Model | Each item | Expand Get a team's project templates — response body — data, next page data item |
$ (allOf 2).custom_type | JSON | Optional | |
$ (allOf 2).custom_type (anyOf 1) | JSON | Alternative | |
$ (allOf 2).custom_type (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a custom type — response body — data data asana created type identifier, gid, name, resource type |
$ (allOf 2).custom_type (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).custom_type (anyOf 2) | null | Alternative |
Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user parent, Add a custom field to a project — response body — data data — Custom Field Setting Response, Get a custom type — response body — data data asana created type identifier, gid, name, resource type, Get a portfolio — response body — data / data / default_access_level: admin, editor, viewer, resource subtype: default portfolio, custom, Get a team's project templates — response body — data, next page data item, Get status updates from an object — response body — data, next page data item, Get users in a team — response body — data data item, Update a workspace — request body — body data
Get a portfolio — response body — data data — sdk__Portfolio Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *portfolio* gives a high-level overview of the status of multiple initiatives in Asana. Portfolios provide a dashboard overview of the state of multiple projects, including a progress report and the most recent [project status](/reference/project-statuses) update. Portfolios have some restrictions on size. Each portfolio has a max of 1500 items and, like projects, a max of 20 custom fields. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the portfolio. |
resource_subtype | string | Optional | The 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_portfolio, custom |
archived | boolean | Optional | [Opt In](/docs/inputoutput-options). True if the portfolio is archived, false if not. Archived portfolios do not show in the UI by default and may be treated differently for queries. |
color | string | Optional | Color of the portfolio. 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 |
start_on | JSON | Optional | |
start_on (anyOf 1) | string | Alternative | The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` 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) | null | Alternative | |
due_on | JSON | Optional | |
due_on (anyOf 1) | string | Alternative | The day on which this portfolio is due. This takes a date with format YYYY-MM-DD. Format: date |
due_on (anyOf 2) | null | Alternative | |
default_access_level | string | Optional | The default access level when inviting new members to the portfolio Known values: admin, editor, viewer |
public | boolean | Optional | Defines whether the portfolio is public to its workspace members. `true` if the portfolio is public to workspace members, `false` if it's visible only to members of the portfolio. New portfolios are private by default. |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
custom_field_settings | array | Optional | Array of custom field definitions that are enabled for the portfolio. These represent which custom fields are available to be used on items within the portfolio, but do not include any values. |
custom_field_settings[] | Model | Each item | Expand Get a goal — response body — data data custom field settings item |
current_status_update | JSON | Optional | |
current_status_update (anyOf 1) | object | Alternative | 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.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 portfolio. |
current_status_update (anyOf 1).gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
current_status_update (anyOf 1).resource_type | string | Optional | The base type of this resource. Read only: true |
current_status_update (anyOf 1).title | string | Optional | The title of the status update. |
current_status_update (anyOf 1).resource_subtype | string | Optional | The 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) | null | Alternative | |
custom_fields | array | Optional | Array of custom field values applied directly to the portfolio itself. These represent the values set on the portfolio, not the fields available for items in the portfolio. |
custom_fields[] | Model | Each item | Expand Get a goal — response body — data data custom fields item |
members | array | Optional | Read only: true |
members[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
owner | Model | Optional | Expand Get an OOO entry — response body — data data user |
workspace | Model | Optional | Expand Get a portfolio — response body — data data workspace |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
privacy_setting | string | Optional | The privacy setting of the portfolio. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* Known values: public_to_domain, members_only |
project_templates | array | Optional | Array of project templates that are in the portfolio Read only: true |
project_templates[] | Model | Each item | Expand Get a job by id — response body — data data new project template |
custom_type | JSON | Optional | |
custom_type (anyOf 1) | Model | Alternative | Expand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent |
custom_type (anyOf 2) | null | Alternative |
Referenced models: Get an OOO entry — response body — data data user, Get a goal — response body — data data custom fields item, Get a job by id — response body — data data new project template, 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 portfolio — response body — data data workspace
Get multiple portfolios — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a portfolio — response body — data data — sdk__Portfolio Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a portfolio — response body — data data — sdk__Portfolio Response
Get portfolio items — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get portfolio items — response body — data, next page data item — sdk__Portfolio Item Compact |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get portfolio items — response body — data, next page data item — sdk__Portfolio Item Compact
Get portfolio items — response body — data, next page data item — Portfolio Item Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Search projects in a workspace — response body — data data item |
$ (anyOf 2) | Model | Alternative | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact |
Referenced models: Get a portfolio membership — response body — data data portfolio — Portfolio Compact, Search projects in a workspace — response body — data data item
Get portfolio items — response body — data, next page data item — sdk__Portfolio Item Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get a rate — response body — data data parent |
$ (anyOf 2) | Model | Alternative | Expand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493 |
Referenced models: Get a rate — response body — data data parent, Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
Remove a portfolio item — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
item | string | Required within parent | The item to remove from the portfolio. |