Get a portfolio

get https://app.asana.com/api/1.0/portfolios/{portfolio_gid}

Returns the complete portfolio record for a single portfolio.

Responses

Response body

object

data

object

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 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

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the portfolio.

archived

boolean

Opt In. 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

Color of the portfolio.

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

created_at

date-time

The time at which this resource was created.

created_by

object

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

custom_field_settings

array of objects

Array of custom field settings applied to the portfolio.

custom_field_settings

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

project

object

Deprecated: new integrations should prefer the parent field. The id of the project that this custom field settings refers to.

is_important

boolean

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.

parent

object

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.

custom_field

object

The custom field that is applied to the parent.

current_status_update

object | null

The latest status_update posted to this portfolio.

due_on

date | null

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

custom_fields

array of objects

Array of Custom Fields.

custom_fields

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the custom field.

type

string

Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values.

text enum multi_enum number date people

enum_options

array of objects

Conditional. Only relevant for custom fields of type 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.

enum_options

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the enum option.

enabled

boolean

Whether or not the enum option is a selectable value for the custom field.

color

string

The color of the enum option. Defaults to ‘none’.

enabled

boolean

Conditional. Determines if the custom field is enabled or not.

representation_type

string

This field tells the type of the custom field.

text enum multi_enum number date people formula custom_id

id_prefix

string | null

This field is the unique custom ID string for the custom field.

is_formula_field

boolean

Conditional. This flag describes whether a custom field is a formula custom field.

date_value

object | null

Conditional. Only relevant for custom fields of type date. This object reflects the chosen date (and optionally, time) value of a date custom field. If no date is selected, the value of date_value will be null.

enum_value

object | null

Conditional. Only relevant for custom fields of type enum. This object is the chosen value of an enum custom field.

multi_enum_values

array of objects

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

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the enum option.

enabled

boolean

Whether or not the enum option is a selectable value for the custom field.

color

string

The color of the enum option. Defaults to ‘none’.

number_value

number | null

Conditional. This number is the value of a number custom field.

text_value

string | null

Conditional. This string is the value of a text custom field.

display_value

string | null

A 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.

members

array of objects

members

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

Read-only except when same user as requester. The user’s name.

owner

object

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

start_on

date | null

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.

workspace

object

Create-only. The workspace or organization that the portfolio belongs to.

permalink_url

string

A url that points directly to the object within Asana.

public

boolean

True if the portfolio is public to its workspace members.

default_access_level

string

The default access level when inviting new members to the portfolio

admin editor viewer

privacy_setting

string

The privacy setting of the portfolio. Note: Administrators in your organization may restrict the values of privacy_setting.

public_to_domain members_only

project_templates

array of objects

Array of project templates that are in the portfolio

project_templates

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

Name of the project template.

Language

Credentials

OAuth2

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.asana.com/api/1.0/portfolios/portfolio_gid \
3
     --header 'accept: application/json'


xxxxxxxxxx
179
}
1
{
2
  "data": {
3
    "gid": "12345",
4
    "resource_type": "portfolio",
5
    "name": "Bug Portfolio",
6
    "archived": false,
7
    "color": "light-green",
8
    "created_at": "2012-02-22T02:06:58.147Z",
9
    "created_by": {
10
      "gid": "12345",
11
      "resource_type": "user",
12
      "name": "Greg Sanchez"
13
    },
14
    "custom_field_settings": [
15
      {
16
        "gid": "12345",
17
        "resource_type": "custom_field_setting",
18
        "project": {
19
          "gid": "12345",
20
          "resource_type": "project",
21
          "name": "Stuff to buy"
22
        },
23
        "is_important": false,
24
        "parent": {
25
          "gid": "12345",

200Successfully retrieved the requested portfolio.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.