Skip to main content

Asana Component

Manage users, projects, and teams in your Asana workspace

Component key: asana ·
· Changelog ↓

Description

Asana is a web and mobile application designed to help teams organize, track, and manage their work.

Use the Asana component to manage users, projects, and teams in your Asana workspace.

A Note on Asana Pagination

Asana's API is paginated. That means that their API will return up to 100 results for any query. If additional results are available, an Asana step will return an additional property, next_page alongside the data that is returned.

{
"data": {},
"next_page": {
"offset": "yJ0eXAiOiJKV1QiLCJhbGciOiJIRzI1NiJ9",
"path": "/tasks?project=1337&limit=5&offset=yJ0eXAiOiJKV1QiLCJhbGciOiJIRzI1NiJ9",
"uri": "https://app.asana.com/api/1.0/tasks?project=1337&limit=5&offset=yJ0eXAiOiJKV1QiLCJhbGciOiJIRzI1NiJ9"
}
}

The offset returned from next_page can be used in a subsequent query to fetch additional results.

See Asana's docs for information about Asana's paginated API, and this quickstart for information on looping over a paginated API in Prismatic.

Connections

Personal Access Token

key: apiKey

A personal access token can be used for development and testing purposes. For production deployments, use the OAuth 2.0 connection to allow users to authenticate with their own Asana credentials.

Prerequisites

  • An active Asana account with permissions to create personal access tokens

Setup Steps

To generate a personal access token:

  1. Log in to Asana and navigate to app.asana.com/0/my-apps
  2. Click + Create new token
  3. Enter a description for the token and click Create token
  4. Copy the generated token value
Security Note

Personal access tokens are tied to the user account that created them and inherit that user's permissions. Store tokens securely and rotate them regularly.

Configure the Connection

  • Enter the Personal Access Token value into the connection configuration

For more information on personal access tokens, refer to the Asana Docs.

InputNotesExample
Personal Access Token

Log in to the Asana Developer Portal to fetch a personal access token for development purposes.

1/example

OAuth 2.0

key: oauth2

To connect to Asana using OAuth 2.0, create an OAuth application within Asana's developer portal. This allows users to authenticate with their Asana credentials.

Prerequisites

  • An active Asana account
  • Permissions to create OAuth applications in Asana

Setup Steps

  1. Log in to Asana and navigate to app.asana.com/0/my-apps
  2. Click Create new app
  3. Enter a name for the application and agree to Asana's terms and conditions
  4. Open OAuth from the left-hand menu
  5. Click + Add redirect URL and enter the OAuth callback URL: https://oauth2.prismatic.io/callback
  6. Copy the generated Client ID and Client secret values

Configure the Connection

  • Enter the Client ID and Client secret from the OAuth application
  • For Scopes, specify the required permissions using the format <resource>:<action>:
ScopeDescription
defaultBasic access to user identity and workspace membership
tasks:readRead tasks, subtasks, and task details
tasks:writeCreate, update, and delete tasks
projects:readRead projects and project details
projects:writeCreate, update, and delete projects
users:readRead user profiles and team membership
workspaces:readRead workspace and organization details
attachments:readRead file attachments on tasks
attachments:writeUpload and manage attachments
webhooks:readRead webhook subscriptions
webhooks:writeCreate and manage webhooks

Example scope configurations:

  • Read-only access: default tasks:read projects:read users:read workspaces:read
  • Task management: default tasks:read tasks:write projects:read users:read
  • Full project access: default tasks:read tasks:write projects:read projects:write users:read workspaces:read
  • Webhook-enabled: default tasks:read projects:read webhooks:read webhooks:write
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Asana

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

Generate from the Asana Developer Portal.

Client secret

Generate from the Asana Developer Portal.

Scopes

Space separated OAuth scopes using the format <resource>:<action> (e.g., tasks:read, projects:write). Leave blank for full access. See Asana API documentation for more information.

tasks:read projects:read users:read
Token URL

The OAuth 2.0 Token URL for Asana

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

Triggers

Comments & Activity Trigger

Get notified when a comment or activity (task updates, changes, etc.) is created, updated, or deleted in a project. | key: storiesTrigger

InputNotesExample
Connection
Project ID

Provide the unique identifier of the project.

375893453
Trigger When Added

Determines if the webhook will trigger when a comment or activity is added.

true
Trigger When Changed

Determines if the webhook will trigger when a comment or activity is changed.

true
Trigger When Deleted

Determines if the webhook will trigger when a comment or activity is deleted.

true
Trigger When Removed

Determines if the webhook will trigger when a comment or activity is removed.

true
Trigger When Undeleted

Determines if the webhook will trigger when a comment or activity is undeleted.

true

Project Tasks Trigger

Get notified when a task is created, updated, or deleted in a project. | key: projectTasksTrigger

InputNotesExample
Connection
Project ID

Provide the unique identifier of the project.

375893453
Trigger When Added

Determines if the webhook will trigger when a task is added.

true
Trigger When Changed

Determines if the webhook will trigger when a task is changed.

true
Trigger When Deleted

Determines if the webhook will trigger when a task is deleted.

true
Trigger When Removed

Determines if the webhook will trigger when a task is removed.

true
Trigger When Undeleted

Determines if the webhook will trigger when a task is undeleted.

true

Webhook

Receive and validate webhook requests from Asana for webhooks you configure. | key: webhook


Workspace Projects Trigger

Get notified when a project is created, updated, or deleted in a workspace. | key: workspaceProjectsTrigger

InputNotesExample
Connection
Trigger When Added

Determines if the webhook will trigger when a project is added.

true
Trigger When Changed

Determines if the webhook will trigger when a project is changed.

true
Trigger When Deleted

Determines if the webhook will trigger when a project is deleted.

true
Trigger When Removed

Determines if the webhook will trigger when a project is removed.

true
Trigger When Undeleted

Determines if the webhook will trigger when a project is undeleted.

true
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Data Sources

Select Attachment

Select an attachment from a dropdown menu | key: selectAttachment | type: picklist

InputNotesExample
Connection
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Select Attachment
Loading…

Select Custom Field

Select a custom field from a dropdown menu | key: selectCustomField | type: picklist

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Select Custom Field
Loading…

Select Portfolio

Select a portfolio from a dropdown menu | key: selectPortfolio | type: picklist

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Select Portfolio
Loading…

Select Projects

Select a project from a dropdown menu | key: selectProject | type: picklist

InputNotesExample
Connection
Team ID

Provide the unique identifier of the team.

843750385
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Select Section

Select a section from a dropdown menu | key: selectSection | type: picklist

InputNotesExample
Connection
Project ID

Provide the unique identifier of the project.

375893453

Select Tag

Select a tag from a dropdown menu | key: selectTag | type: picklist

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Select Task

Select a task from a dropdown menu | key: selectTask | type: picklist

InputNotesExample
Assignee ID

Provide the unique identifier of the assignee. Assignee ID must be provided with a Workspace ID.

843750385
Connection
Project ID

Provide the unique identifier of the project.

375893453
Workspace ID

The gid of the workspace. Required when account has multiple workspaces. Workspace ID must be provided with an Assignee ID.

375893453

Select Team

Select a team from a dropdown menu | key: selectTeam | type: picklist

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Select User

Select a user from a dropdown menu | key: selectUser | type: picklist

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Select Workspace

Select a workspace from a dropdown menu | key: selectWorkspace | type: picklist

InputNotesExample
Connection

Actions

Add Custom Field To Portfolio

Add a custom field to an existing portfolio | key: addCustomFieldToPortfolio

InputNotesExample
Connection
Field ID

The unique identifier of the field

843750385
Insert After

The ID of the field or section to insert this one insert after

843750385
Insert before

The ID of the field or section to insert this one before

843750385
Is Important

Determines if the custom field will be marked as important

true
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Add Custom Field To Portfolio
Loading…

Add Custom Field To Project

Add a new Custom Field to an existing Project | key: addCustomFieldToProject

InputNotesExample
Connection
Field ID

The unique identifier of the field

843750385
Insert After

The ID of the field or section to insert this one insert after

843750385
Insert before

The ID of the field or section to insert this one before

843750385
Is Important

Determines if the custom field will be marked as important

true
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for Add Custom Field To Project
Loading…

Add Followers To Task

Add followers to an existing task | key: addFollowersToTask

InputNotesExample
Connection
Followers List

For each item, provide the unique identifier of an existing userId.

843750385
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Add Followers To Task
Loading…

Add Tag To Task

Add a tag to an existing task | key: addTagToTask

InputNotesExample
Connection
Tag ID

The unique identifier of the tag

843750385
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Add Tag To Task
Loading…

Add Task To Section

Add an existing task to the given section of a project | key: addTaskToSection

InputNotesExample
Connection
Insert After

The ID of the field or section to insert this one insert after

843750385
Insert before

The ID of the field or section to insert this one before

843750385
Section ID

The unique identifier of the section

843750385
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Add Task To Section
Loading…

Add User To Team

Add an existing user to the given team | key: addUserToTeam

InputNotesExample
Connection
Team ID

Provide the unique identifier of the team.

843750385
User ID

The global ID of a user

375893453
Example Payload for Add User To Team
Loading…

Add User To Workspace

Add a new user to the given workspace | key: addUser

InputNotesExample
Connection
User ID

The global ID of a user

375893453
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Add User To Workspace
Loading…

Add Users To Portfolio

Add existing users to the given portfolio | key: addUserToPortfolio

InputNotesExample
Connection
Members

For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user.

843750385
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Add Users To Portfolio
Loading…

Add Users To Project

Add an existing user to the given project | key: addUserToProject

InputNotesExample
Connection
Members

For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user.

843750385
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for Add Users To Project
Loading…

Attach File to Task

Attach a file to a task | key: attachFileToTask

InputNotesExample
Connection
File

File to attach. This should be a reference to a previous step

File Name

Name of the file to attach

my-image.png
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Attach File to Task
Loading…

Create Portfolio

Create a new portfolio | key: createPortfolio

InputNotesExample
Connection
Color

Provide a value for the color of the object.

light-green
Public

True if the object is public to its team.

false
Members

For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user.

843750385
Portfolio Name

Give a name to the portfolio

My Portfolio
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Create Portfolio
Loading…

Create Project

Create a new project inside of an existing team or organization | key: createProjects

InputNotesExample
Archived

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

false
Connection
Default View

The default view of the project.

list
Due On

The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at.

2019-09-15
Followers

Provide a comma separated string of users.

8570756435,375893453
HTML Notes

The notes of the text with formatting as HTML.

<body>Mittens is a <em>really</em> good cat.</body>
Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Owner ID

Provide the unique identifier of the owner of the project.

375893453
Privacy Setting

The privacy setting of the project. Note: Administrators in your organization may restrict these values.

Project Color

The default color for your project

light-green
Start On

The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format

2021-11-14
Team ID

The team that this project is shared with. This field only exists for projects in organizations. Including this field if you do not meet those conditions could cause your request to fail.

375893453
Workspace ID

Include this value if you would like this project to be included in a workspace.

375893453
Example Payload for Create Project
Loading…

Create Section

Create a new section of a project | key: createSection

InputNotesExample
Connection
Connection
Insert After

The ID of the field or section to insert this one insert after

843750385
Insert before

The ID of the field or section to insert this one before

843750385
Project ID

Provide the unique identifier of the project.

375893453
Section Name

Provide a value for the name of the section

843750385
Example Payload for Create Section
Loading…

Create Status Update

Create a status update from a project, portfolio, or goal | key: createStatusUpdate

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Project, portfolio, or goal ID

The GID for a project, portfolio, or goal

375893453
This represents the current state of the objecton_track
Status Text

The text content of the status update.

The project is moving forward according to plan.
Status Title

The title of the project status update.

Example Status Update - Jun 15
Example Payload for Create Status Update
Loading…

Create Tag

Create a new tag | key: createTag

InputNotesExample
Connection
Color

Provide a value for the color of the object.

light-green
Followers List

For each item, provide the unique identifier of an existing userId.

843750385
Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Create Tag
Loading…

Create Task

Create a new task inside a workspace or organization | key: createTask

InputNotesExample
Approval Status

Provide a string value for the approval status of the task.

Pending
Connection
Assignee ID

Provide the unique identifier of the assignee.

843750385
Assignee Section ID

Provide the unique identifier of the section to assign the task to. The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list.

843750385
Assignee Status

Provide a string value representing the status the task has in relation to its assignee. This field is deprecated, you can still use it to form requests but it is not recommended for creating new records.

upcoming
Completed By

Provide a string value for the name of the user who completed the task. You can also provide a userId, or email.

John Doe
Due At

Provide an ISO 8601 date string in UTC and should NOT be used together with Due On.

2019-09-15T02:06:58.147Z
Due On

The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at.

2019-09-15
Followers List

For each item, provide the unique identifier of an existing userId.

843750385
HTML Notes

The notes of the text with formatting as HTML.

<body>Mittens is a <em>really</em> good cat.</body>
Completed

True if the task is completed, false if not. Select 'Do not change' to avoid updating this value.

Is Liked

This flag will mark the specified task as 'liked' in your Asana account.

Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Parent ID

Provide the unique identifier of the parent element.

843750385
Project List

For each item, provide the unique identifier of the project.

843750385
Resource Subtype

Provide a string value for the type of object.

task
Start At

Date and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with start_on. Note: due_at must be present in the request when setting or unsetting the start_at parameter.

2019-09-14T02:06:58.147Z
Start On

The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format

2021-11-14
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Create Task
Loading…

Create Team

Create a new team | key: createTeam

InputNotesExample
Connection
Organization or Workspace ID

Provide the unique identifier of the organization or workspace

375893453
Description

Provide a string value for the description of the team.

This is an example description
Name

Provide a string value for the name of the team.

Engineering Team
Example Payload for Create Team
Loading…

Create Webhook

Create a webhook to send data from Asana to an instance URL | key: createWebhook

InputNotesExample
Connection
Webhook URL

Reference a flow's URL from the trigger payload

Filter

Specify the filter parameters for the webhook in JSON format

[
  {
    "action": "changed",
    "fields": [
      "due_at",
      "due_on",
      "dependencies"
    ],
    "resource_subtype": "milestone",
    "resource_type": "task"
  }
]
Resource ID

The GID of a project, portfolio, goal, task, etc - the resource to listen for

375893453

Delete Attachment

Delete an existing attachment | key: deleteAttachment

InputNotesExample
Connection
Attachment ID

Provide an id for the given attachment

843750385
Example Payload for Delete Attachment
Loading…

Delete Instance Webhooks

Delete all Asana webhooks that point to a flow in this instance | key: deleteInstanceWebhooks

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

Delete Portfolio

Delete the information and metadata of a portfolio | key: deletePortfolio

InputNotesExample
Connection
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Delete Portfolio
Loading…

Delete Project

Delete the information and metadata of a project by Id | key: deleteProjects

InputNotesExample
Connection
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for Delete Project
Loading…

Delete Section

Delete the information and metadata of a section | key: deleteSection

InputNotesExample
Connection
Section ID

The unique identifier of the section

843750385
Example Payload for Delete Section
Loading…

Delete Status

Delete a status update | key: deleteStatus

InputNotesExample
Connection
Status ID

The gid of the status update

375893453
Example Payload for Delete Status
Loading…

Delete Tag

Delete the information and metadata of the given tag | key: deleteTag

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Tag ID

The unique identifier of the tag

843750385
Example Payload for Delete Tag
Loading…

Delete Task

Delete the information and metadata of an existing task | key: deleteTask

InputNotesExample
Connection
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Delete Task
Loading…

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

InputNotesExample
Connection
Webhook ID

The gid of the workspace

375893453
Example Payload for Delete Webhook
Loading…

Find Tag by Name

Find a tag of a given name within a workspace | key: findTagByName

InputNotesExample
Connection
Tag Name

Note: if multiple tags share a name, only one tag will be returned.

Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Find Tag by Name
Loading…

Find Team by Name

Find a team of a given name within a workspace | key: findTeamByName

InputNotesExample
Connection
Team Name

Note: if multiple teams share a name, only one team will be returned.

Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Find Team by Name
Loading…

Find User by Name or Email

Find a user with the given name or email address in your workspace | key: findUserByNameOrEmail

InputNotesExample
Connection
User's Email

Note: if multiple users share an email address, only one user will be returned.

john.doe@example.com
User's Full Name

Note: if multiple users share a name, only one user will be returned.

John Doe
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Find User by Name or Email
Loading…

Find Workspace by Name

Find a workspace of a given name | key: findWorkspaceByName

InputNotesExample
Connection
Workspace Name
Example Payload for Find Workspace by Name
Loading…

Get Attachments

Get the information and metadata of an attachment | key: getAttachment

InputNotesExample
Connection
Attachment ID

Provide an id for the given attachment

843750385
Example Payload for Get Attachments
Loading…

Get Current User

Get information about the currently authenticated user | key: getCurrentUser

InputNotesExample
Connection
Example Payload for Get Current User
Loading…

Get Custom Field

Get the information and metadata of a custom field | key: getCustomField

InputNotesExample
Connection
Field ID

The unique identifier of the field

843750385
Example Payload for Get Custom Field
Loading…

Get Portfolio

Get the information and metadata of a portfolio | key: getPortfolio

InputNotesExample
Connection
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Get Portfolio
Loading…

Get Project

Get the information and metadata of a project by Id | key: getProject

InputNotesExample
Connection
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for Get Project
Loading…

Get Section

Get the information and metadata of a section | key: getSection

InputNotesExample
Connection
Section ID

The unique identifier of the section

843750385
Example Payload for Get Section
Loading…

Get Status Update

Get a status update | key: getStatusUpdate

InputNotesExample
Connection
Status ID

The gid of the status update

375893453
Example Payload for Get Status Update
Loading…

Get Status Updates from Object

Get status updates from a project, portfolio, or goal | key: getStatusesForObject

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Project, portfolio, or goal ID

The GID for a project, portfolio, or goal

375893453
Example Payload for Get Status Updates from Object
Loading…

Get Tag

Get the information and metadata of the given tag | key: getTag

InputNotesExample
Connection
Tag ID

The unique identifier of the tag

843750385
Example Payload for Get Tag
Loading…

Get Task

Get the information and metadata of a task | key: getTask

InputNotesExample
Connection
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Get Task
Loading…

Get Team

Get the information and metadata of a team | key: getTeam

InputNotesExample
Connection
Team ID

Provide the unique identifier of the team.

843750385
Example Payload for Get Team
Loading…

Get User

Get the information and metadata of a user | key: getUsers

InputNotesExample
Connection
User ID

The global ID of a user

375893453
Example Payload for Get User
Loading…

Get Workspace

Get the information and metadata of the given Workspace | key: getWorkspace

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Get Workspace
Loading…

List Custom Fields

List all custom fields in a workspace | key: listCustomFields

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Custom Fields
Loading…

List Portfolio Items

List all items in a given portfolio | key: listPortfolioItems

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for List Portfolio Items
Loading…

List Portfolios

List portfolios that the authenticated user owns | key: listPortfolios

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Portfolios
Loading…

List Projects

Return a list of all projects connected to your account | key: listProjects

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Projects
Loading…

List Sections

List all sections of the given project | key: listSections

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for List Sections
Loading…

List Subtasks

Return a list of all subtasks in a given task | key: listSubtasks

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
List All Nested Subtasks?false
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for List Subtasks
Loading…

List Tags

List all tags in your account | key: listTags

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Tags
Loading…

List Tags In Task

List all tags in a given task | key: listTagsInTask

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for List Tags In Task
Loading…

List task attachments

List all attachments in a given task | key: listAttachments

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for List task attachments
Loading…

List Tasks

Return a list of tasks | key: listTasks

InputNotesExample
Connection
Assignee ID

Provide the unique identifier of the assignee.

843750385
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Project ID

Provide the unique identifier of the project.

375893453
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453

You must specify a project, or a combination of an assignee and workspace.

Example Payload for List Tasks
Loading…

List Teams

List all teams in the given workspace | key: listTeams

InputNotesExample
Connection
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Teams
Loading…

List Users

List all users in your account | key: listUsers

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Workspace ID

Optionally filter by workspace ID

375893453
Example Payload for List Users
Loading…

List Workspace Webhooks

List all webhooks configured in Asana, including those for other integrations | key: listWebhooks

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Show only instance webhooks

Show only webhooks that point to this instance

true
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for List Workspace Webhooks
Loading…

List Workspaces

List of all workspaces connected to your account | key: listWorkspaces

InputNotesExample
Connection
Limit

The maximum number of items you would like returned (between 1 and 100)

20
Offset

An offset token returned from a previous query that had a next_page property

eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9
Example Payload for List Workspaces
Loading…

Raw Request

Send raw HTTP request to Asana | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/goals), The base URL is already included (https://app.asana.com/api/1.0). For example, to connect to https://app.asana.com/api/1.0/goals, only /goals is entered in this field.

/goals
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Remove Assignee From Task

Remove the assignee from the given task | key: removeAssigneeFromTask

InputNotesExample
Connection
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Remove Assignee From Task
Loading…

Remove Custom Field From Portfolio

Remove a custom field from an existing portfolio | key: removeCustomFieldFromPortfolio

InputNotesExample
Connection
Field ID

The unique identifier of the field

843750385
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Remove Custom Field From Portfolio
Loading…

Remove Custom Field From Project

Remove an existing Custom Field from an existing Project | key: removeCustomFieldFromProject

InputNotesExample
Connection
Field ID

The unique identifier of the field

843750385
Project ID

Provide the unique identifier of the project.

375893453
Example Payload for Remove Custom Field From Project
Loading…

Remove Followers From Task

Remove followers from the given task | key: removeFollowersFromTask

InputNotesExample
Connection
Followers List

For each item, provide the unique identifier of an existing userId.

843750385
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Remove Followers From Task
Loading…

Remove Portfolio Item

Remove an existing item from the given portfolio | key: removePortfolioItem

InputNotesExample
Connection
Item ID

Provide the unique identifier of the Item.

843750385
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Remove Portfolio Item
Loading…

Remove Tag From Task

Remove a tag from the given task | key: removeTagFromTask

InputNotesExample
Connection
Tag ID

The unique identifier of the tag

843750385
Task ID

Provide the unique identifier for the task.

375893453
Example Payload for Remove Tag From Task
Loading…

Remove Users From Portfolio

Remove existing users from the given portfolio | key: removeUserFromPortfolio

InputNotesExample
Connection
Members

For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user.

843750385
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Example Payload for Remove Users From Portfolio
Loading…

Update Portfolio

Update the information and metadata of the given portfolio | key: updatePortfolio

InputNotesExample
Connection
Color

Provide a value for the color of the object.

light-green
Public

True if the object is public to its team.

false
Portfolio ID

Provide the unique identifier of the portfolio.

843750385
Portfolio Name

Give a name to the portfolio

My Portfolio
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Update Portfolio
Loading…

Update Project

Update the information and metadata of a project | key: updateProject

InputNotesExample
Archived

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

false
Connection
Default View

The default view of the project.

Due On

The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at.

2019-09-15
Followers

Provide a comma separated string of users.

8570756435,375893453
HTML Notes

The notes of the text with formatting as HTML.

<body>Mittens is a <em>really</em> good cat.</body>
Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Owner ID

Provide the unique identifier of the owner of the project.

375893453
Privacy Setting

The privacy setting of the project. Note: Administrators in your organization may restrict these values.

Project Color

The default color for your project

light-green
Project ID

Provide the unique identifier of the project.

375893453
Start On

The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format

2021-11-14
Team ID

The team that this project is shared with. This field only exists for projects in organizations. Including this field if you do not meet those conditions could cause your request to fail.

375893453
Example Payload for Update Project
Loading…

Update Section

Update the information and metadata of a project section | key: updateSection

InputNotesExample
Connection
Insert After

The ID of the field or section to insert this one insert after

843750385
Insert before

The ID of the field or section to insert this one before

843750385
Section ID

The unique identifier of the section

843750385
Section Name

Provide a value for the name of the section

843750385
Example Payload for Update Section
Loading…

Update Tag

Update the information and metadata of the given tag | key: updateTag

InputNotesExample
Connection
Color

Provide a value for the color of the object.

light-green
Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Tag ID

The unique identifier of the tag

843750385
Example Payload for Update Tag
Loading…

Update Task

Update the information and metadata of the given task | key: updateTask

InputNotesExample
Approval Status

Provide a string value for the approval status of the task.

Pending
Connection
Assignee ID

Provide the unique identifier of the assignee.

843750385
Assignee Section ID

Provide the unique identifier of the section to assign the task to. The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list.

843750385
Assignee Status

Provide a string value representing the status the task has in relation to its assignee. This field is deprecated, you can still use it to form requests but it is not recommended for creating new records.

upcoming
Completed By

Provide a string value for the name of the user who completed the task. You can also provide a userId, or email.

John Doe
Due At

Provide an ISO 8601 date string in UTC and should NOT be used together with Due On.

2019-09-15T02:06:58.147Z
Due On

The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at.

2019-09-15
HTML Notes

The notes of the text with formatting as HTML.

<body>Mittens is a <em>really</em> good cat.</body>
Completed

True if the task is completed, false if not. Select 'Do not change' to avoid updating this value.

Is Liked

This flag will mark the specified task as 'liked' in your Asana account.

Name

Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability.

Example - Populate customers page with live data
Notes

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

These are some example notes.
Parent ID

Provide the unique identifier of the parent element.

843750385
Resource Subtype

Provide a string value for the type of object.

task
Start At

Date and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with start_on. Note: due_at must be present in the request when setting or unsetting the start_at parameter.

2019-09-14T02:06:58.147Z
Start On

The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format

2021-11-14
Task ID

Provide the unique identifier for the task.

375893453
Workspace ID

The gid of the workspace. Required when account has multiple workspaces.

375893453
Example Payload for Update Task
Loading…

Changelog

2026-04-30

Updated spectral version

2026-03-31

Various modernizations and documentation updates

2026-03-16

Improved input field documentation with formatted URL links for better readability

2026-02-26

Added inline data sources for portfolios, custom fields, and attachments to enable dynamic dropdown selection

2025-12-02

Added support for granular scopes to the OAuth 2.0 connection, allowing users to request specific permissions (e.g., tasks:read, projects:write) instead of full account access

2025-10-17

Enhanced webhook lifecycle management with improved event trigger handling and automated cleanup

2025-09-19

Added inline data sources for projects, sections, tags, tasks, teams, users, and workspaces to enhance data selection capabilities