Asana Connector Module Connector Reference

Anypoint Connector for Asana (Asana Connector) synchronizes data and automates business processes between Asana and third-party applications, either on-premises or in the cloud.

Configurations

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Oauth2 Connection Provider

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

Parameter base URI, each instance/tenant gets its own

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

TLS Configuration

Tls

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

The OAuth consumerKey as registered with the service provider

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint. URL

https://app.asana.com/-/oauth_authorize

Access Token Url

String

The service provider’s accessToken endpoint. URL

https://app.asana.com/-/oauth_token

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation

default openid email profile

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to execute right before starting the OAuth dance

After

String

The name of a flow to execute right after an accessToken has been received

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener that will catch the access token callback endpoint..

x

Callback Path

String

The path of the access token callback endpoint.

x

Authorize Path

String

The path of the local http endpoint. which triggers the OAuth dance

x

External Callback Url

String

If the callback endpoint. is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one.

Unsecured Connection Provider

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the connection Idle Timeout

SECONDS

Proxy Config

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Base Uri

String

Parameter base URI, each instance/tenant gets its own

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

TLS Configuration

Tls

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Associated Sources

Operations

Create Batch Request

<asana:create-batch>

Make multiple requests in parallel to Asana’s API. This operation makes an HTTP POST request to the /batch endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Batch Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Custom Field

<asana:create-custom-fields>

Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set.

A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as 'Due Date' or 'Assignee'.

A custom field’s type must be one of 'text', 'enum', or 'number'. Returns the full record of the newly created custom field.

This operation makes an HTTP POST request to the /custom_fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.

Custom Fields Content

Any

the content to use

#[payload]

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Enum Option For Custom Field

<asana:create-custom-fields-enum-options-by-custom-field-gid>

Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 50 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option. This operation makes an HTTP POST request to the /custom_fields/{custom_field_gid}/enum_options endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Custom field gid

String

Globally unique identifier for the custom field.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Custom Fields Enum Options Content

Any

the content to use

#[payload]

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Insert Enum Option For Custom Field

<asana:create-custom-fields-enum-options-insert-by-custom-field-gid>

Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.

This operation makes an HTTP POST request to the /custom_fields/{custom_field_gid}/enum_options/insert endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Custom field gid

String

Globally unique identifier for the custom field.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Custom Fields Enum Options Insert Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Organization Export

<asana:create-organization-exports>

This method creates a request to export an Organization. Asana will complete the export at some point after you create the request. This operation makes an HTTP POST request to the /organization_exports endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Organization Exports Content

Any

the content to use

#[payload]

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Portfolio

<asana:create-portfolios>

Creates a new portfolio in the given workspace with the supplied name. Note that portfolios created in the Asana UI may have some state (like the 'Priority' custom field) which is automatically added to the portfolio when it is created. Portfolios created via our API will not be created with the same initial state to allow integrations to create their own starting state on a portfolio. This operation makes an HTTP POST request to the /portfolios endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Custom Field Setting For Portfolio

<asana:create-portfolios-add-custom-field-setting-by-portfolio-gid>

Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/addCustomFieldSetting endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Portfolios Add Custom Field Setting Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Item For Portfolio

<asana:create-portfolios-add-item-by-portfolio-gid>

Add an item to a portfolio. Returns an empty data block. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/addItem endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Add Item Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Members For Portfolio

<asana:create-portfolios-add-members-by-portfolio-gid>

Adds the specified list of users as members of the portfolio. Returns the updated portfolio record. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/addMembers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Add Members Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Custom Field Setting For Portfolio

<asana:create-portfolios-remove-custom-field-setting-by-portfolio-gid>

Removes a custom field setting from a portfolio. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/removeCustomFieldSetting endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Portfolios Remove Custom Field Setting Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Item For Portfolio

<asana:create-portfolios-remove-item-by-portfolio-gid>

Remove an item from a portfolio. Returns an empty data block. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/removeItem endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Remove Item Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Members For Portfolio

<asana:create-portfolios-remove-members-by-portfolio-gid>

Removes the specified list of users from members of the portfolio. Returns the updated portfolio record. This operation makes an HTTP POST request to the /portfolios/{portfolio_gid}/removeMembers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Remove Members Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Project

<asana:create-projects>

Create a new project in a workspace or team. Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization. If the workspace for your project is an organization, you must also supply a team to share the project with. Returns the full record of the newly created project. This operation makes an HTTP POST request to the /projects endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Custom Field Setting For Project

<asana:create-projects-add-custom-field-setting-by-project-gid>

Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project. This operation makes an HTTP POST request to the /projects/{project_gid}/addCustomFieldSetting endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Portfolios Add Custom Field Setting Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Followers For Project

<asana:create-projects-add-followers-by-project-gid>

Adds the specified list of users as followers to the project. Followers are a subset of members, therefore if the users are not already members of the project they will also become members as a result of this operation. Returns the updated project record. This operation makes an HTTP POST request to the /projects/{project_gid}/addFollowers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Add Followers Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Members For Project

<asana:create-projects-add-members-by-project-gid>

Adds the specified list of users as members of the project. Returns the updated project record. This operation makes an HTTP POST request to the /projects/{project_gid}/addMembers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Add Members Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Duplicate Project

<asana:create-projects-duplicate-by-project-gid>

Creates and returns a job that will asynchronously handle the duplication. This operation makes an HTTP POST request to the /projects/{project_gid}/duplicate endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Duplicate Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Project Status For Project

<asana:create-projects-project-statuses-by-project-gid>

Creates a new status update on the project. Returns the full record of the newly created project status update. This operation makes an HTTP POST request to the /projects/{project_gid}/project_statuses endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Project Statuses Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Custom Field Setting For Project

<asana:create-projects-remove-custom-field-setting-by-project-gid>

Removes a custom field setting from a project. This operation makes an HTTP POST request to the /projects/{project_gid}/removeCustomFieldSetting endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Portfolios Remove Custom Field Setting Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Followers For Project

<asana:create-projects-remove-followers-by-project-gid>

Removes the specified list of users from following the project, this will not affect project membership status. Returns the updated project record. This operation makes an HTTP POST request to the /projects/{project_gid}/removeFollowers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Remove Followers Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Members For Project

<asana:create-projects-remove-members-by-project-gid>

Removes the specified list of users from members of the project. Returns the updated project record. This operation makes an HTTP POST request to the /projects/{project_gid}/removeMembers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Portfolios Remove Members Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Section For Project

<asana:create-projects-sections-by-project-gid>

Creates a new section in a project. Returns the full record of the newly created section. This operation makes an HTTP POST request to the /projects/{project_gid}/sections endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Sections Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Insert Section For Project

<asana:create-projects-sections-insert-by-project-gid>

Move sections relative to each other. One of before_section or after_section is required. Sections cannot be moved between projects. Returns an empty data block. This operation makes an HTTP POST request to the /projects/{project_gid}/sections/insert endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Sections Insert Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Task For Section

<asana:create-sections-add-task-by-section-gid>

Add a task to a specific, existing section. This will remove the task from other sections of the project. The task is inserted at the top of a section unless an insert_before or insert_after parameter is declared. This does not work for separators (tasks with the resource_subtype of section). This operation makes an HTTP POST request to the /sections/{section_gid}/addTask endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Section gid

String

The globally unique identifier for the section.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Sections Add Task Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Tag

<asana:create-tags>

Creates a new tag in a workspace or organization. Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization. Returns the full record of the newly created tag. This operation makes an HTTP POST request to the /tags endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tags Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Task

<asana:create-tasks>

Creating a new task is as easy as POSTing to the /tasks endpoint. with a data block containing the fields you’d like to set on the task. Any unspecified fields will take on default values. Every task is required to be created in a specific workspace, and this workspace cannot be changed once set. The workspace need not be set explicitly if you specify projects or a parent task instead. This operation makes an HTTP POST request to the /tasks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Dependencies For Task

<asana:create-tasks-add-dependencies-by-task-gid>

Marks a set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies. This operation makes an HTTP POST request to the /tasks/{task_gid}/addDependencies endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Dependencies Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Dependents For Task

<asana:create-tasks-add-dependents-by-task-gid>

Marks a set of tasks as dependents of this task, if they are not already dependents. A task can have at most 30 dependents. This operation makes an HTTP POST request to the /tasks/{task_gid}/addDependents endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Dependents Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Followers For Task

<asana:create-tasks-add-followers-by-task-gid>

Adds followers to a task. Returns an empty data block. Each task can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated task record, described above. This operation makes an HTTP POST request to the /tasks/{task_gid}/addFollowers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Followers Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Project For Task

<asana:create-tasks-add-project-by-task-gid>

Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. addProject can also be used to reorder a task within a project or section that already contains it. At most one of insert_before, insert_after, or section should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify insert_before or insert_after and a task within the section to anchor the position of this task. Returns an empty data block. This operation makes an HTTP POST request to the /tasks/{task_gid}/addProject endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Project Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add Tag For Task

<asana:create-tasks-add-tag-by-task-gid>

Adds a tag to a task. Returns an empty data block. This operation makes an HTTP POST request to the /tasks/{task_gid}/addTag endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Tag Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Attachment For Task

<asana:create-tasks-attachments-by-task-gid>

Upload an attachment. This method uploads an attachment to a task and returns the compact record for the created attachment object. It is not possible to attach files from third party services such as Dropbox, Box & Google Drive via the API.

You must download the file content first and then upload it as any other attachment.

The 100MB size limit on attachments in Asana is enforced on this endpoint. This endpoint expects a multipart/form-data encoded request containing the full contents of the file to be uploaded. Requests made should follow the HTTP/1.1 specification that line terminators are of the form CRLF or \r\n outlined [here](http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01#Basic-Rules) in order for the server to reliably and properly handle the request. This operation makes an HTTP POST request to the /tasks/{task_gid}/attachments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Attachment Request Content

Any

the content to use

#[payload]

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Duplicate Task

<asana:create-tasks-duplicate-by-task-gid>

Creates and returns a job that will asynchronously handle the duplication. This operation makes an HTTP POST request to the /tasks/{task_gid}/duplicate endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Duplicate Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Dependencies For Task

<asana:create-tasks-remove-dependencies-by-task-gid>

Unlinks a set of dependencies from this task. This operation makes an HTTP POST request to the /tasks/{task_gid}/removeDependencies endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Dependencies Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Dependents For Task

<asana:create-tasks-remove-dependents-by-task-gid>

Unlinks a set of dependents from this task. This operation makes an HTTP POST request to the /tasks/{task_gid}/removeDependents endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Add Dependents Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Follower For Task

<asana:create-tasks-remove-followers-by-task-gid>

Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task. This operation makes an HTTP POST request to the /tasks/{task_gid}/removeFollowers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Remove Followers Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Project For Task

<asana:create-tasks-remove-project-by-task-gid>

Removes the task from the specified project. The task will still exist in the system, but it will not be in the project anymore. Returns an empty data block. This operation makes an HTTP POST request to the /tasks/{task_gid}/removeProject endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Remove Project Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove Tag For Task

<asana:create-tasks-remove-tag-by-task-gid>

Removes a tag from a task. Returns an empty data block. This operation makes an HTTP POST request to the /tasks/{task_gid}/removeTag endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Remove Tag Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Set Parent For Task

<asana:create-tasks-set-parent-by-task-gid>

parent, or no parent task at all. Returns an empty data block. When using insert_before and insert_after, at most one of those two options can be specified, and they must already be subtasks of the parent. This operation makes an HTTP POST request to the /tasks/{task_gid}/setParent endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Set Parent Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Story For Task

<asana:create-tasks-stories-by-task-gid>

Adds a story to a task. This endpoint. currently only allows for comment stories to be created. The comment will be authored by the currently authenticated user, and timestamped when the server receives the request. Returns the full record for the new story added to the task. This operation makes an HTTP POST request to the /tasks/{task_gid}/stories endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Stories Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Subtask For Task

<asana:create-tasks-subtasks-by-task-gid>

Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask. This operation makes an HTTP POST request to the /tasks/{task_gid}/subtasks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Tasks Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Team

<asana:create-teams>

Creates a team within the current workspace. This operation makes an HTTP POST request to the /teams endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Teams Content

Any

the content to use

#[payload]

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add User For Team

<asana:create-teams-add-user-by-team-gid>

The user making this call must be a member of the team to add others. The user being added must exist in the same organization as the team. This operation makes an HTTP POST request to the /teams/{team_gid}/addUser endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Team gid

String

Globally unique identifier for the team.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Teams Add User Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Project For Team

<asana:create-teams-projects-by-team-gid>

Creates a project shared with the given team. Returns the full record of the newly created project. This operation makes an HTTP POST request to the /teams/{team_gid}/projects endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Team gid

String

Globally unique identifier for the team.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove User For Team

<asana:create-teams-remove-user-by-team-gid>

The user making this call must be a member of the team to remove themselves or others. This operation makes an HTTP POST request to the /teams/{team_gid}/removeUser endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Team gid

String

Globally unique identifier for the team.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Teams Remove User Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Webhook

<asana:create-webhooks>

Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake.

When a webhook is created, we will send a test POST to the target with an X-Hook-Secret header. The target must respond with a '200’OK or '204’No Content and a matching X-Hook-Secret header to confirm that this webhook subscription is indeed expected.

We strongly recommend storing this secret to use to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake that it fails to setup, you will receive an error in response to your attempt to create it.

This means you need to be able to receive and complete the webhook while the POST request is in-flight (in other words, have a server that can handle requests asynchronously).

  • Request

    curl -H "Authorization: Bearer " \ -X POST https://app.asana.com/api/1.0/webhooks \ -d "resource=8675309" \ -d "target=https://example.com/receive-webhook/7654"

  • Handshake sent to: https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: <secret>

  • Handshake response sent by: example.com HTTP/1.1 '200’X-Hook-Secret: <secret>

  • Response:

    HTTP/1.1 '201'{ "data": { "gid": "43214", "resource": { "gid": "8675309", "name": "Bugs" }, "target": "https://example.com/receive-webhook/7654", "active": false, "last_success_at": null, "last_failure_at": null, "last_failure_content": null } }

This operation makes an HTTP POST request to the /webhooks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Webhooks Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Add User For Workspace

<asana:create-workspaces-add-user-by-workspace-gid>

Add a user to a workspace or organization. The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user. This operation makes an HTTP POST request to the /workspaces/{workspace_gid}/addUser endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workspace gid

String

Globally unique identifier for the workspace or organization.

x

Opt pretty

Boolean

Provides 'pretty' output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Workspaces Add User Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Project For Workspace

<asana:create-workspaces-projects-by-workspace-gid>

Returns the compact project records for all projects in the workspace. If the workspace for your project is an organization, you must also supply a team to share the project with. Returns the full record of the newly created project. This operation makes an HTTP POST request to the /workspaces/{workspace_gid}/projects endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workspace gid

String

Globally unique identifier for the workspace or organization.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Projects Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Remove User For Workspace

<asana:create-workspaces-remove-user-by-workspace-gid>

Remove a user from a workspace or organization. The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address. Returns an empty data record. This operation makes an HTTP POST request to the /workspaces/{workspace_gid}/removeUser endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workspace gid

String

Globally unique identifier for the workspace or organization.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Workspaces Remove User Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Create Tag For Workspace

<asana:create-workspaces-tags-by-workspace-gid>

Creates a new tag in a workspace or organization. Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization. Returns the full record of the newly created tag. This operation makes an HTTP POST request to the /workspaces/{workspace_gid}/tags endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workspace gid

String

Globally unique identifier for the workspace or organization.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Create Tags Content

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Attachment

<asana:delete-attachments-by-attachment-gid>

Deletes a specific, existing attachment. Returns an empty data record. This operation makes an HTTP DELETE request to the /attachments/{attachment_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Attachment gid

String

Globally unique identifier for the attachment.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Custom Field

<asana:delete-custom-fields-by-custom-field-gid>

A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record. This operation makes an HTTP DELETE request to the /custom_fields/{custom_field_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Custom field gid

String

Globally unique identifier for the custom field.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Portfolio

<asana:delete-portfolios-by-portfolio-gid>

An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio. Returns an empty data record. This operation makes an HTTP DELETE request to the /portfolios/{portfolio_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Project Status

<asana:delete-project-statuses-by-project-status-gid>

Deletes a specific, existing project status update. Returns an empty data record. This operation makes an HTTP DELETE request to the /project_statuses/{project_status_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project status gid

String

The project status update to get.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Project

<asana:delete-projects-by-project-gid>

A specific, existing project can be deleted by making a DELETE request on the URL for that project. Returns an empty data record. This operation makes an HTTP DELETE request to the /projects/{project_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Section

<asana:delete-sections-by-section-gid>

A specific, existing section can be deleted by making a DELETE request on the URL for that section. Note that sections must be empty to be deleted. The last remaining section cannot be deleted. Returns an empty data block. This operation makes an HTTP DELETE request to the /sections/{section_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Section gid

String

The globally unique identifier for the section.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Story

<asana:delete-stories-by-story-gid>

Deletes a story. A user can only delete stories they have created. Returns an empty data record. This operation makes an HTTP DELETE request to the /stories/{story_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Story gid

String

Globally unique identifier for the story.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Tag

<asana:delete-tags-by-tag-gid>

A specific, existing tag can be deleted by making a DELETE request on the URL for that tag. Returns an empty data record. This operation makes an HTTP DELETE request to the /tags/{tag_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Tag gid

String

Globally unique identifier for the tag.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Task

<asana:delete-tasks-by-task-gid>

A specific, existing task can be deleted by making a DELETE request on the URL for that task. Deleted tasks go into the 'trash' of the user making the delete request. Tasks can be recovered from the trash within a period of 30 days; afterward they are completely removed from the system. Returns an empty data record. This operation makes an HTTP DELETE request to the /tasks/{task_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Task gid

String

The task to operate on.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Delete Webhook

<asana:delete-webhooks-by-webhook-gid>

This method permanently removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued. This operation makes an HTTP DELETE request to the /webhooks/{webhook_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Webhook gid

String

Globally unique identifier for the webhook.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Attachment

<asana:get-attachments-by-attachment-gid>

Get the full record for a single attachment. This operation makes an HTTP GET request to the /attachments/{attachment_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Attachment gid

String

Globally unique identifier for the attachment.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Custom Field

<asana:get-custom-fields-by-custom-field-gid>

Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions. This operation makes an HTTP GET request to the /custom_fields/{custom_field_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Custom field gid

String

Globally unique identifier for the custom field.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Events

<asana:get-events>

Returns the full record for all events that have occurred since the sync token was created. A GET request to the endpoint. /[path_to_resource]/events can be made in lieu of including the resource ID in the data for the request.

NOTE: The resource returned will be the resource that triggered the event. This may be different from the one that the events were requested for. For example, a subscription to a project will contain events for tasks contained within the project.* This operation makes an HTTP GET request to the /events endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

resource

String

A resource ID to subscribe to. The resource can be a task or project.

x

sync

String

A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated.

NOTE: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a 412 Precondition Failed error, and include a fresh sync token in the response.

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Job

<asana:get-jobs-by-job-gid>

Returns the full record for a job. This operation makes an HTTP GET request to the /jobs/{job_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job gid

String

Globally unique identifier for the job.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Organization Export

<asana:get-organization-exports-by-organization-export-gid>

Returns details of a previously-requested Organization export. This operation makes an HTTP GET request to the /organization_exports/{organization_export_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Organization export gid

String

Globally unique identifier for the organization export.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Teams For Organization

<asana:get-organizations-teams-by-workspace-gid>

Returns the compact records for all teams in the organization visible to the authorized user. This operation makes an HTTP GET request to the /organizations/{workspace_gid}/teams endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workspace gid

String

Globally unique identifier for the workspace or organization.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Portfolio Memberships

<asana:get-portfolio-memberships>

Returns a list of portfolio memberships in compact representation. You must specify portfolio, portfolio and user, or workspace and user. This operation makes an HTTP GET request to the /portfolio_memberships endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

portfolio

String

The portfolio to filter results on.

user

String

A string identifying a user. This can either be the string "me", an email, or the gid of a user.

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

workspace

String

The workspace to filter results on.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Portfolio Membership

<asana:get-portfolio-memberships-by-portfolio-membership-gid>

Returns the complete portfolio record for a single portfolio membership. This operation makes an HTTP GET request to the /portfolio_memberships/{portfolio_membership_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio membership gid

String

Portfolio membership gid

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Portfolios

<asana:get-portfolios>

Returns a list of the portfolios in compact representation that are owned by the current API user. This operation makes an HTTP GET request to the /portfolios endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

workspace

String

The workspace or organization to filter portfolios on.

x

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

owner

String

The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own.

x

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Portfolio

<asana:get-portfolios-by-portfolio-gid>

Returns the complete portfolio record for a single portfolio. This operation makes an HTTP GET request to the /portfolios/{portfolio_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Custom Field Settings For Portfolio

<asana:get-portfolios-custom-field-settings-by-portfolio-gid>

Returns a list of all of the custom fields settings on a portfolio, in compact form. This operation makes an HTTP GET request to the /portfolios/{portfolio_gid}/custom_field_settings endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Items For Portfolio

<asana:get-portfolios-items-by-portfolio-gid>

Get a list of the items in compact form in a portfolio. This operation makes an HTTP GET request to the /portfolios/{portfolio_gid}/items endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Portfolio Memberships For Portfolio

<asana:get-portfolios-portfolio-memberships-by-portfolio-gid>

Returns the compact portfolio membership records for the portfolio. This operation makes an HTTP GET request to the /portfolios/{portfolio_gid}/portfolio_memberships endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Portfolio gid

String

Globally unique identifier for the portfolio.

x

user

String

A string identifying a user. This can either be the string "me", an email, or the gid of a user.

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Project Membership

<asana:get-project-memberships-by-project-membership-gid>

Returns the complete project record for a single project membership. This operation makes an HTTP GET request to the /project_memberships/{project_membership_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project membership gid

String

Project membership gid

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Project Status

<asana:get-project-statuses-by-project-status-gid>

Returns the complete record for a single status update. This operation makes an HTTP GET request to the /project_statuses/{project_status_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project status gid

String

The project status update to get.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Projects

<asana:get-projects>

Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. Note: This endpoint. may timeout for large domains. Try filtering by team! This operation makes an HTTP GET request to the /projects endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

workspace

String

The workspace or organization to filter projects on.

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

team

String

The team to filter projects on.

archived

Boolean

Only return projects whose archived field takes on the value of this parameter.

false

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Project

<asana:get-projects-by-project-gid>

Returns the complete project record for a single project. This operation makes an HTTP GET request to the /projects/{project_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Custom Field Settings For Project

<asana:get-projects-custom-field-settings-by-project-gid>

Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, opt_fields can be used to include more data than is returned in the compact representation. See the [getting started guide on input/output options](https://developers.asana.com/docs/#input-output-options) for more information. This operation makes an HTTP GET request to the /projects/{project_gid}/custom_field_settings endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Project Memberships For Project

<asana:get-projects-project-memberships-by-project-gid>

Returns the compact project membership records for the project. This operation makes an HTTP GET request to the /projects/{project_gid}/project_memberships endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

user

String

A string identifying a user. This can either be the string "me", an email, or the gid of a user.

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Project Statuses For Project

<asana:get-projects-project-statuses-by-project-gid>

Returns the compact project status update records for all updates on the project. This operation makes an HTTP GET request to the /projects/{project_gid}/project_statuses endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Sections For Project

<asana:get-projects-sections-by-project-gid>

Returns the compact records for all sections in the specified project. This operation makes an HTTP GET request to the /projects/{project_gid}/sections endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Task Counts For Project

<asana:get-projects-task-counts-by-project-gid>

Get an object that holds task count fields. All fields are excluded by default. You must [opt in](/docs/input-output-options) using opt_fields to get any information from this endpoint. This endpoint has an additional [rate limit](/docs/standard-rate-limits) and each field counts especially high against our [cost limits](/docs/cost-limits). Milestones are just tasks, so they are included in the num_tasks, num_incomplete_tasks, and num_completed_tasks counts. This operation makes an HTTP GET request to the /projects/{project_gid}/task_counts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Tasks For Project

<asana:get-projects-tasks-by-project-gid>

Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time. This operation makes an HTTP GET request to the /projects/{project_gid}/tasks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Project gid

String

Globally unique identifier for the project.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Section

<asana:get-sections-by-section-gid>

Returns the complete record for a single section. This operation makes an HTTP GET request to the /sections/{section_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Section gid

String

The globally unique identifier for the section.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:RETRY_EXHAUSTED

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Tasks For Section

<asana:get-sections-tasks-by-section-gid>

Board view only: Returns the compact section records for all tasks within the given section. This operation makes an HTTP GET request to the /sections/{section_gid}/tasks endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Section gid

String

The globally unique identifier for the section.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Any

For Configurations

Throws

  • ASANA:BAD_REQUEST

  • ASANA:CLIENT_ERROR

  • ASANA:CONNECTIVITY

  • ASANA:INTERNAL_SERVER_ERROR

  • ASANA:NOT_ACCEPTABLE

  • ASANA:NOT_FOUND

  • ASANA:SERVER_ERROR

  • ASANA:SERVICE_UNAVAILABLE

  • ASANA:TIMEOUT

  • ASANA:TOO_MANY_REQUESTS

  • ASANA:UNAUTHORIZED

  • ASANA:UNSUPPORTED_MEDIA_TYPE

Get Story

<asana:get-stories-by-story-gid>

Returns the full record for a single story. This operation makes an HTTP GET request to the /stories/{story_gid} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Story gid

String

Globally unique identifier for the story.

x

Opt pretty

Boolean

Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

false

Opt fields

Array of String

Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options.

limit

Number

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offset

String

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'

output Mime Type

String

The mime type of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy