Skip to main content

Asana Component

Manage users, projects, and teams in your Asana workspace

Component key: asana

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

Asana Personal Access Token

Developer personal access tokens can be used for development purposes, but you should use an OAuth 2.0 connection when you deploy your integration (so your users can log in with their accounts).

To generate an personal access token, log in to Asana and open app.asana.com/0/my-apps. Then, click + Create new token.

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

Asana OAuth 2.0 Connection

To make API requests of Asana on behalf of your customers you need to create an "OAuth app" within Asana. Log in to Asana and then visit app.asana.com/0/my-apps.

  • Click Create new app
  • Give your app a name and agree to Asana's terms and conditions
  • Open OAuth from the left-hand menu and take note of the generated Client ID and Client secret
  • Click + Add redirect URL and enter https://oauth2.prismatic.io/callback

Finally, when creating your Asana integration update your Asana connection with the Client ID and Client secret that you noted.

Triggers

Project Tasks Trigger

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


Stories Trigger

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


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


Data Sources

Select Projects

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


Select Workspace

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


Actions

Add Custom Field To Portfolio

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

Output Example Payload

{
"data": {
"data": {}
}
}

Add Custom Field To Project

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202476446247138",
"resource_type": "custom_field_setting",
"custom_field": {
"gid": "1202476274909067",
"resource_type": "custom_field",
"created_by": {
"gid": "1202467472237333",
"resource_type": "user",
"name": "Example User"
},
"resource_subtype": "multi_enum",
"type": "multi_enum",
"name": "Do you want these things?",
"enum_options": [
{
"gid": "1202476274909068",
"resource_type": "enum_option",
"enabled": true,
"name": "My First Option",
"color": "green"
},
{
"gid": "1202476274909069",
"resource_type": "enum_option",
"enabled": true,
"name": "My Second Option",
"color": "red"
},
{
"gid": "1202476274909070",
"resource_type": "enum_option",
"enabled": true,
"name": "My Third Option",
"color": "orange"
}
]
},
"is_important": true,
"parent": {
"gid": "1202467472002605",
"resource_type": "project",
"name": "Brand redesign campaign"
},
"project": {
"gid": "1202467472002605",
"resource_type": "project",
"name": "Brand redesign campaign"
}
}
}
}

Add Followers To Task

Add followers to an existing task | key: addFollowersToTask

Output Example Payload

{
"data": {
"data": {
"gid": "1202461451752271",
"resource_type": "task",
"created_at": "2022-06-16T21:17:30.519Z",
"name": "My task name",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
]
}
}
}

Add Tag To Task

Add a tag to an existing task | key: addTagToTask

Output Example Payload

{
"data": {
"data": {}
}
}

Add Task To Section

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

Output Example Payload

{
"data": {
"data": {}
}
}

Add User To Team

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202178854270530",
"resource_type": "team_membership",
"team": {
"gid": "1202178854270529",
"resource_type": "team",
"name": "Engineering"
},
"user": {
"gid": "1202178852626547",
"resource_type": "user",
"name": "Example User"
},
"is_guest": false
}
}
}

Add User To Workspace

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

Output Example Payload

{
"data": {
"data": {
"gid": "1126508793140155",
"resource_type": "user",
"name": "Example User",
"email": "user@example.com",
"photo": {
"image_21x21": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_21x21.png",
"image_27x27": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_27x27.png",
"image_36x36": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_36x36.png",
"image_60x60": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_60x60.png",
"image_128x128": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_128x128.png"
}
}
}
}

Add Users To Portfolio

Add existing users to the given portfolio | key: addUserToPortfolio

Output Example Payload

{
"data": {
"data": {
"gid": "1202474374782519",
"resource_type": "portfolio",
"created_at": "2022-06-20T16:48:04.621Z",
"created_by": {
"gid": "1202467472237333",
"resource_type": "user",
"name": "Example User"
},
"owner": {
"gid": "1202467472237333",
"resource_type": "user",
"name": "Example User"
},
"name": "My Portfolio",
"public": true,
"members": [
{
"gid": "1202467472237333",
"resource_type": "user",
"name": "Example User"
},
{
"gid": "1202467584678838",
"resource_type": "user",
"name": "Developer Name"
}
],
"custom_field_settings": [],
"workspace": {
"gid": "1202467471973207",
"resource_type": "workspace",
"name": "Example Workspace"
},
"permalink_url": "https://app.asana.com/0/portfolio/1202474374782519",
"color": "none",
"due_on": null,
"start_on": null,
"current_status_update": {
"gid": "1202475750145512",
"resource_type": "status_update",
"title": "This Portfolio of work is on track!"
}
}
}
}

Add Users To Project

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461834400501",
"resource_type": "project",
"created_at": "2022-06-16T22:59:28.974Z",
"modified_at": "2022-06-16T22:59:31.222Z",
"members": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"owner": {
"gid": "1202178852626547",
"resource_type": "user"
},
"due_on": null,
"current_status": null,
"public": true,
"name": "My new project name",
"notes": "My new project notes",
"html_notes": "<body>My new project notes</body>",
"archived": false,
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"team": {
"gid": "1202178854270529",
"resource_type": "team"
},
"start_on": null,
"color": "light-green",
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
]
}
}
}

Attach File to Task

Attach a file to a task | key: attachFileToTask

Output Example Payload

{
"data": {
"data": {
"gid": "12345",
"resource_type": "attachment",
"name": "Screenshot.png",
"resource_subtype": "asana"
}
}
}

Create Portfolio

Create a new portfolio | key: createPortfolio

Output Example Payload

{
"data": {
"data": {
"gid": "12345",
"resource_type": "portfolio",
"color": "light-green",
"name": "Bug Portfolio",
"created_at": "2012-02-22T02:06:58.147Z",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"current_status_update": {
"gid": "12345",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"title": "Status Update - Jun 15"
},
"custom_field_settings": [
{
"gid": "12345",
"resource_type": "custom_field_setting",
"custom_field": {
"gid": "12345",
"resource_type": "custom_field",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"currency_code": "EUR",
"custom_label": "gold pieces",
"custom_label_position": "suffix",
"description": "Development team priority",
"display_value": "blue",
"enabled": true,
"enum_options": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"enum_value": {
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
},
"format": "custom",
"has_notifications_enabled": true,
"is_global_to_workspace": true,
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"name": "Status",
"number_value": 5.2,
"precision": 2,
"resource_subtype": "text",
"text_value": "Some Value",
"type": "text"
},
"is_important": false,
"parent": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
},
"project": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
}
}
],
"due_on": "2019-09-15",
"members": [
{
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
],
"owner": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"permalink_url": "https://app.asana.com/0/resource/123456789/list",
"public": false,
"start_on": "2019-09-14",
"workspace": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
}
}
}
}

Create Project

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461772995112",
"resource_type": "project",
"created_at": "2022-06-16T22:53:48.986Z",
"modified_at": "2022-06-16T22:53:48.986Z",
"members": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"owner": {
"gid": "1202178852626547",
"resource_type": "user"
},
"due_on": null,
"current_status": null,
"public": false,
"name": "My Cool Project",
"notes": "Some notes on my project",
"archived": false,
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"team": {
"gid": "1202178854270529",
"resource_type": "team"
},
"start_on": null,
"color": "light-green",
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"html_notes": "<body>Some notes on my project</body>"
}
}
}

Create Section

Create a new section of a project | key: createSection

Output Example Payload

{
"data": {
"data": {
"gid": "1202465892953048",
"resource_type": "section",
"created_at": "2022-06-17T15:53:48.455Z",
"name": "My Example Section",
"project": {
"gid": "1202178854270532",
"resource_type": "project"
}
}
}
}

Create Status Update

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202466825616154",
"resource_type": "status_update",
"num_hearts": 0,
"num_likes": 0,
"title": "Example project is going well",
"created_at": "2022-06-17T19:09:58.169Z",
"modified_at": "2022-06-17T19:09:58.169Z",
"status_type": "on_track",
"text": "It'll be completed on time!",
"parent": {
"gid": "1202178854270532",
"resource_type": "project",
"name": "Example Project"
},
"resource_subtype": "project_status_update",
"hearted": false,
"hearts": [],
"liked": false,
"likes": [],
"created_by": {
"gid": "1202178852626547",
"resource_type": "user",
"name": "Example User"
},
"html_text": "<body>It'll be completed on time!</body>"
}
}
}

Create Tag

Create a new tag | key: createTag

Output Example Payload

{
"data": {
"data": {
"gid": "1202453507919841",
"resource_type": "tag",
"create_at": "2022-06-15T17:03:26.911Z",
"name": "My Example Tag",
"workspace": {
"gid": 1126509132283071,
"resource_type": "workspace"
},
"color": "light-green",
"followers": []
}
}
}

Create Task

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461248558215",
"projects": [],
"memberships": [],
"resource_type": "task",
"created_at": "2022-06-16T20:30:21.641Z",
"modified_at": "2022-06-16T20:30:21.932Z",
"name": "My Task Name",
"is_rendered_as_separator": false,
"notes": "Here's my task notes!",
"assignee": {
"gid": "1202178852626547",
"resource_type": "user"
},
"completed": false,
"assignee_status": "inbox",
"completed_at": null,
"due_on": null,
"due_at": null,
"resource_subtype": "default_task",
"start_on": null,
"tags": [],
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"liked": false,
"num_likes": 0,
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"html_notes": "<body>Here's my task notes!</body>",
"parent": null,
"likes": []
}
}
}

Create Team

Create a new team | key: createTeam

Output Example Payload

{
"data": {
"data": {
"gid": "1202466032099844",
"resource_type": "team",
"name": "My New Team",
"permalink_url": "https://app.asana.com/0/1202466032099844",
"organization": {
"gid": "1126509132283071",
"resource_type": "workspace",
"name": "Prismatic"
}
}
}
}

Create Webhook

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


Delete Attachment

Delete an existing attachment | key: deleteAttachment

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Instance Webhooks

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


Delete Portfolio

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

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Project

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

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Section

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

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Status

Delete a status update | key: deleteStatus

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Tag

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

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Task

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

Output Example Payload

{
"data": {
"data": {}
}
}

Delete Webhook

Delete a webhook by ID | key: deleteWebhook

Output Example Payload

{
"data": {}
}

Find Tag by Name

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

Output Example Payload

{
"data": {
"gid": "1202467057873527",
"color": "dark-green",
"created_at": "2022-06-17T20:28:26.601Z",
"name": "My Example Tag Name",
"resource_type": "tag"
}
}

Find Team by Name

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

Output Example Payload

{
"data": {
"gid": "1126509132283071",
"name": "Example Team",
"resource_type": "team"
}
}

Find User by Name or Email

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

Output Example Payload

{
"data": {
"gid": "1126508793140155",
"email": "user@example.com",
"name": "Example User",
"resource_type": "user",
"workspaces": [
{
"gid": "1126509132283071",
"name": "Example Workspace",
"resource_type": "workspace"
}
]
}
}

Find Workspace by Name

Find a workspace of a given name | key: findWorkspaceByName

Output Example Payload

{
"data": {
"gid": "1126509132283071",
"name": "Example Workspace",
"resource_type": "workspace"
}
}

Get Attachments

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

Output Example Payload

{
"data": {
"data": {
"gid": "12345",
"resource_type": "attachment",
"name": "Screenshot.png",
"resource_subtype": "dropbox",
"created_at": "2012-02-22T02:06:58.147Z",
"download_url": "https://s3.amazonaws.com/assets/123/Screenshot.png",
"host": "dropbox",
"parent": {
"gid": "12345",
"resource_type": "task",
"name": "Bug Task",
"resource_subtype": "default_task"
},
"permanent_url": "https://s3.amazonaws.com/assets/123/Screenshot.png",
"view_url": "https://www.dropbox.com/s/123/Screenshot.png"
}
}
}

Get Current User

Get information about the currently authenticated user | key: getCurrentUser

Output Example Payload

{
"data": {
"data": {
"gid": "1126508793140155",
"email": "user@example.com",
"name": "Example User",
"photo": {
"image_21x21": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_21x21.png",
"image_27x27": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_27x27.png",
"image_36x36": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_36x36.png",
"image_60x60": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_60x60.png",
"image_128x128": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_128x128.png"
},
"resource_type": "user",
"workspaces": [
{
"gid": "1126509132283071",
"name": "Example Workspace",
"resource_type": "workspace"
}
]
}
}
}

Get Custom Field

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202467472002610",
"enum_options": [
{
"gid": "1202467472002611",
"color": "red",
"enabled": true,
"name": "High",
"resource_type": "enum_option"
},
{
"gid": "1202467472002612",
"color": "orange",
"enabled": true,
"name": "Medium",
"resource_type": "enum_option"
},
{
"gid": "1202467472002613",
"color": "yellow-orange",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
}
],
"name": "Priority",
"description": "Asana-created. Track the priority of each task.",
"resource_subtype": "enum",
"resource_type": "custom_field"
}
}
}

Get Portfolio

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

Output Example Payload

{
"data": {
"data": {
"gid": "12345",
"resource_type": "portfolio",
"color": "light-green",
"name": "Bug Portfolio",
"created_at": "2012-02-22T02:06:58.147Z",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"current_status_update": {
"gid": "12345",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"title": "Status Update - Jun 15"
},
"custom_field_settings": [
{
"gid": "12345",
"resource_type": "custom_field_setting",
"custom_field": {
"gid": "12345",
"resource_type": "custom_field",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"currency_code": "EUR",
"custom_label": "gold pieces",
"custom_label_position": "suffix",
"description": "Development team priority",
"display_value": "blue",
"enabled": true,
"enum_options": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"enum_value": {
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
},
"format": "custom",
"has_notifications_enabled": true,
"is_global_to_workspace": true,
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"name": "Status",
"number_value": 5.2,
"precision": 2,
"resource_subtype": "text",
"text_value": "Some Value",
"type": "text"
},
"is_important": false,
"parent": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
},
"project": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
}
}
],
"due_on": "2019-09-15",
"members": [
{
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
],
"owner": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"permalink_url": "https://app.asana.com/0/resource/123456789/list",
"public": false,
"start_on": "2019-09-14",
"workspace": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
}
}
}
}

Get Project

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461773653662",
"archived": false,
"color": "light-green",
"created_at": "2022-06-16T22:55:11.208Z",
"current_status": null,
"custom_fields": [],
"due_on": null,
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"html_notes": "<body>My new project notes</body>",
"members": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"modified_at": "2022-06-16T22:55:13.275Z",
"name": "My new project name",
"notes": "My new project notes",
"owner": {
"gid": "1202178852626547",
"resource_type": "user"
},
"public": true,
"resource_type": "project",
"start_on": null,
"team": {
"gid": "1202178854270529",
"resource_type": "team"
},
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
}
}

Get Section

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202178854270533",
"created_at": "2022-04-25T19:28:56.749Z",
"name": "Discussion topics",
"project": {
"gid": "1202178854270532",
"name": "My Example Project",
"resource_type": "project"
},
"resource_type": "section"
}
}
}

Get Status Update

Get a status update | key: getStatusUpdate

Output Example Payload

{
"data": {
"data": {
"gid": "1202466832682204",
"created_at": "2022-06-17T19:14:25.512Z",
"created_by": {
"gid": "1202178852626547",
"name": "Example User",
"resource_type": "user"
},
"modified_at": "2022-06-17T19:14:26.506Z",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"status_type": "on_track",
"text": "It'll be completed on time!",
"title": "Example project is going well",
"parent": {
"gid": "1202178854270532",
"name": "Example Project",
"resource_type": "project"
}
}
}
}

Get Status Updates from Object

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

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202466843571433",
"created_at": "2022-06-17T19:22:53.380Z",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"status_type": "at_risk",
"text": "We accidentally force-pushed over our repo!",
"title": "It's going terribly!",
"parent": {
"gid": "1202178854270532",
"resource_type": "project"
}
},
{
"gid": "1202466947841625",
"created_at": "2022-06-17T19:17:33.744Z",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"status_type": "on_track",
"text": "It'll be completed on time!",
"title": "Example project is going well",
"parent": {
"gid": "1202178854270532",
"resource_type": "project"
}
}
]
}
}

Get Tag

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461566347259",
"color": "light-green",
"created_at": "2022-06-16T21:44:38.673Z",
"followers": [],
"name": "My Example Tag",
"notes": "My Notes",
"resource_type": "tag",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
}
}

Get Task

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

Output Example Payload

{
"data": {
"data": {
"gid": "75834703724",
"projects": "",
"resource_type": "task",
"name": "MyTask",
"notes": "These are my example task notes!",
"completed": false,
"resource_subtype": "default_task",
"tags": "",
"workspace": {
"gid": "867452364563",
"resource_type": "workspace",
"name": "Example Workspace"
},
"custom_fields": {},
"assignee": {
"gid": "32493284234",
"name": "Example Assignee",
"resource_type": "user"
},
"parent": null,
"assignee_status": "inbox",
"hearted": false
}
}
}

Get Team

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

Output Example Payload

{
"data": {
"data": {
"gid": "1126509132283073",
"name": "Example Team",
"organization": {
"gid": "1126509132283071",
"name": "Example Org",
"resource_type": "workspace"
},
"permalink_url": "https://app.asana.com/0/1126509132283073",
"resource_type": "team"
}
}
}

Get User

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

Output Example Payload

{
"data": {
"data": {
"gid": "1126508793140155",
"email": "user@example.com",
"name": "Example User",
"photo": {
"image_21x21": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_21x21.png",
"image_27x27": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_27x27.png",
"image_36x36": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_36x36.png",
"image_60x60": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_60x60.png",
"image_128x128": "https://s3.amazonaws.com/profile_photos/1126508793140155.1126509132283075.joZwntHYCrotR7QnI82A_128x128.png"
},
"resource_type": "user",
"workspaces": [
{
"gid": "1126509132283071",
"name": "Example Workspace",
"resource_type": "workspace"
}
]
}
}
}

Get Workspace

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

Output Example Payload

{
"data": {
"data": {
"gid": "1126509132283071",
"email_domains": [
"example.com"
],
"is_organization": true,
"name": "Example Workspace",
"resource_type": "workspace"
}
}
}

List Custom Fields

List all custom fields in a workspace | key: listCustomFields

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202467472002610",
"enum_options": [
{
"gid": "1202467472002611",
"color": "red",
"enabled": true,
"name": "High",
"resource_type": "enum_option"
},
{
"gid": "1202467472002612",
"color": "orange",
"enabled": true,
"name": "Medium",
"resource_type": "enum_option"
},
{
"gid": "1202467472002613",
"color": "yellow-orange",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
}
],
"name": "Priority",
"description": "Asana-created. Track the priority of each task.",
"resource_subtype": "enum",
"resource_type": "custom_field"
},
{
"gid": "1202476274909067",
"enum_options": [
{
"gid": "1202476274909068",
"color": "green",
"enabled": true,
"name": "My First Option",
"resource_type": "enum_option"
},
{
"gid": "1202476274909069",
"color": "red",
"enabled": true,
"name": "My Second Option",
"resource_type": "enum_option"
},
{
"gid": "1202476274909070",
"color": "orange",
"enabled": true,
"name": "My Third Option",
"resource_type": "enum_option"
}
],
"name": "Do you want these things?",
"description": "",
"resource_subtype": "multi_enum",
"resource_type": "custom_field"
},
{
"gid": "1202476390317834",
"name": "Milestone",
"description": "",
"resource_subtype": "text",
"resource_type": "custom_field"
},
{
"gid": "1202476390885516",
"name": "Percent Complete",
"description": "",
"precision": 0,
"resource_subtype": "number",
"resource_type": "custom_field"
}
]
}
}

List Portfolio Items

List all items in a given portfolio | key: listPortfolioItems

Output Example Payload

{
"data": {
"data": [
{
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
}
]
}
}

List Portfolios

List portfolios that the authenticated user owns | key: listPortfolios

Output Example Payload

{
"data": {
"data": [
{
"gid": "12345",
"resource_type": "portfolio",
"name": "Example Portfolio"
}
]
}
}

List Projects

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

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202178854270532",
"archived": false,
"color": "light-pink",
"created_at": "2022-04-25T19:28:55.557Z",
"current_status": null,
"custom_fields": [],
"due_on": "2022-05-25",
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"html_notes": "<body>Asana helps you plan your 1:1s in advance, stay focused during the conversation, and track notes and action items.</body>",
"members": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"modified_at": "2022-06-15T21:21:40.641Z",
"name": "[Sample] [Teammate] / Prismatic 1:1",
"notes": "Asana helps you plan your 1:1s in advance, stay focused during the conversation, and track notes and action items.",
"owner": {
"gid": "1202178852626547",
"resource_type": "user"
},
"public": false,
"resource_type": "project",
"start_on": "2022-04-25",
"team": {
"gid": "1202178854270529",
"resource_type": "team"
},
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
]
}
}

List Sections

List all sections of the given project | key: listSections

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202178854270533",
"created_at": "2022-04-25T19:28:56.749Z",
"name": "Discussion topics",
"project": {
"gid": "1202178854270532",
"resource_type": "project"
},
"resource_type": "section"
},
{
"gid": "1202178854270541",
"created_at": "2022-04-25T19:28:59.950Z",
"name": "FYIs",
"project": {
"gid": "1202178854270532",
"resource_type": "project"
},
"resource_type": "section"
}
]
}
}

List Subtasks

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

Output Example Payload

{
"data": {
"data": [
{
"gid": "1234567890123456",
"assignee": null,
"assignee_status": "upcoming",
"completed": false,
"completed_at": null,
"created_at": "2023-11-10T00:29:54.363Z",
"custom_fields": [],
"dependencies": [],
"dependents": [],
"due_at": null,
"due_on": null,
"followers": [
{
"gid": "7890123456789012",
"resource_type": "user"
}
],
"html_notes": "<body></body>",
"is_rendered_as_separator": false,
"liked": false,
"likes": [],
"memberships": [],
"modified_at": "2023-11-10T00:31:18.774Z",
"name": "Task",
"notes": "",
"num_likes": 0,
"num_subtasks": 2,
"parent": {
"gid": "2345678901234567",
"resource_type": "task"
},
"projects": [],
"resource_type": "task",
"start_on": null,
"tags": [],
"resource_subtype": "default_task",
"workspace": {
"gid": "8901234567890123",
"resource_type": "workspace"
}
}
]
}
}

List Tags

List all tags in your account | key: listTags

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202453507919841",
"color": "light-green",
"created_at": "2022-06-15T17:03:26.911Z",
"followers": [],
"name": "My example tag",
"resource_type": "tag",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
]
}
}

List Tags In Task

List all tags in a given task | key: listTagsInTask

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202453664069905",
"color": "light-green",
"created_at": "2022-06-15T17:32:21.828Z",
"followers": [],
"name": "My example tag",
"resource_type": "tag",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
]
}
}

List task attachments

List all attachments in a given task | key: listAttachments

Output Example Payload

{
"data": {
"data": [
{
"gid": "12345",
"resource_type": "attachment",
"name": "Screenshot.png",
"resource_subtype": "dropbox"
}
]
}
}

List Tasks

Return a list of tasks | key: listTasks

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

Output Example Payload

{
"data": {
"data": [
{
"gid": "1202178854270531",
"assignee": {
"gid": "1202178852626547",
"resource_type": "user"
},
"assignee_status": "today",
"completed": false,
"completed_at": null,
"created_at": "2022-04-25T19:28:54.408Z",
"due_at": null,
"due_on": "2022-05-02",
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user"
}
],
"html_notes": "<body>We’ve collected a set of guides, tips, and tutorials to help you learn about Asana. Check it out:<ul><li><a href=\"https://asana.com/guide\">https://asana.com/guide</a></li></ul></body>",
"is_rendered_as_separator": false,
"liked": false,
"likes": [],
"memberships": [
{}
],
"modified_at": "2022-06-15T21:21:41.151Z",
"name": "Learn how Asana works",
"notes": "We’ve collected a set of guides, tips, and tutorials to help you learn about Asana. Check it out: https://asana.com/guide\n",
"num_likes": 0,
"num_subtasks": 0,
"parent": null,
"projects": [
{
"gid": "1202178854270532",
"resource_type": "project"
}
],
"resource_type": "task",
"start_on": null,
"tags": [
{
"gid": "1202453664069905",
"resource_type": "tag"
},
{
"gid": "1202454369674628",
"resource_type": "tag"
},
{
"gid": "1202454863218026",
"resource_type": "tag"
}
],
"resource_subtype": "default_task",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
}
}
]
}
}

List Teams

List all teams in the given workspace | key: listTeams

Output Example Payload

{
"data": {
"data": [
{
"gid": "1126509132283073",
"name": "Founders",
"resource_type": "team"
},
{
"gid": "1201132129713512",
"name": "Design",
"resource_type": "team"
},
{
"gid": "1201340876723312",
"name": "Engineering",
"resource_type": "team"
}
]
}
}

List Users

List all users in your account | key: listUsers

Output Example Payload

{
"data": {
"data": [
{
"gid": "1126508793140155",
"name": "Example User 1",
"resource_type": "user",
"email": "user-1@example.com",
"workspaces": [
{
"gid": "1126509132283071",
"resource_type": "workspace"
}
]
},
{
"gid": "1126508793140156",
"name": "Example User2 ",
"resource_type": "user",
"email": "user-2@example.com",
"workspaces": [
{
"gid": "1126509132283071",
"resource_type": "workspace"
}
]
}
]
}
}

List Workspace Webhooks

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

Output Example Payload

{
"data": [
{
"gid": "1202700984385446",
"active": true,
"resource": {
"gid": "1202467472002605",
"name": "Brand redesign campaign",
"resource_type": "project"
},
"resource_type": "webhook",
"target": "https://hooks.prismatic.io/trigger/EXAMPLE"
}
]
}

List Workspaces

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

Output Example Payload

{
"data": {
"data": [
{
"gid": "1126509132283071",
"name": "Example Workspace 1",
"resource_type": "workspace"
},
{
"gid": "1126509132283072",
"name": "Example Workspace 2",
"resource_type": "workspace"
}
]
}
}

Raw Request

Send raw HTTP request to Asana | key: rawRequest


Remove Assignee From Task

Remove the assignee from the given task | key: removeAssigneeFromTask

Output Example Payload

{
"data": {
"data": {}
}
}

Remove Custom Field From Portfolio

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

Output Example Payload

{
"data": {
"data": {}
}
}

Remove Custom Field From Project

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

Output Example Payload

{
"data": {
"data": {}
}
}

Remove Followers From Task

Remove followers from the given task | key: removeFollowersFromTask

Output Example Payload

{
"data": {
"data": {
"gid": "1202461530991735",
"resource_type": "task",
"created_at": "2022-06-16T21:33:52.572Z",
"name": "My new task name",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"followers": []
}
}
}

Remove Portfolio Item

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

Output Example Payload

{
"data": {
"data": {}
}
}

Remove Tag From Task

Remove a tag from the given task | key: removeTagFromTask

Output Example Payload

{
"data": {
"data": {}
}
}

Remove Users From Portfolio

Remove existing users from the given portfolio | key: removeUserFromPortfolio

Output Example Payload

{
"data": {
"data": {
"gid": "1202476367473313",
"resource_type": "portfolio",
"created_at": "2022-06-20T18:18:47.435Z",
"created_by": {
"gid": "1202467472237333",
"resource_type": "user"
},
"name": "Example Portfolio",
"members": [
{
"gid": "1202467472237333",
"resource_type": "user"
},
{
"gid": "1202467584678838",
"resource_type": "user"
}
],
"custom_field_settings": [],
"workspace": {
"gid": "1202467471973207",
"resource_type": "workspace"
},
"color": "light-green"
}
}
}

Update Portfolio

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

Output Example Payload

{
"data": {
"data": {
"gid": "12345",
"resource_type": "portfolio",
"color": "light-green",
"name": "Bug Portfolio",
"created_at": "2012-02-22T02:06:58.147Z",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"current_status_update": {
"gid": "12345",
"resource_type": "status_update",
"resource_subtype": "project_status_update",
"title": "Status Update - Jun 15"
},
"custom_field_settings": [
{
"gid": "12345",
"resource_type": "custom_field_setting",
"custom_field": {
"gid": "12345",
"resource_type": "custom_field",
"created_by": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"currency_code": "EUR",
"custom_label": "gold pieces",
"custom_label_position": "suffix",
"description": "Development team priority",
"display_value": "blue",
"enabled": true,
"enum_options": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"enum_value": {
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
},
"format": "custom",
"has_notifications_enabled": true,
"is_global_to_workspace": true,
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "enum_option",
"color": "blue",
"enabled": true,
"name": "Low"
}
],
"name": "Status",
"number_value": 5.2,
"precision": 2,
"resource_subtype": "text",
"text_value": "Some Value",
"type": "text"
},
"is_important": false,
"parent": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
},
"project": {
"gid": "12345",
"resource_type": "project",
"name": "Stuff to buy"
}
}
],
"due_on": "2019-09-15",
"members": [
{
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
}
],
"owner": {
"gid": "12345",
"resource_type": "user",
"name": "Greg Sanchez"
},
"permalink_url": "https://app.asana.com/0/resource/123456789/list",
"public": false,
"start_on": "2019-09-14",
"workspace": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
}
}
}
}

Update Project

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461680419124",
"resource_type": "project",
"created_at": "2022-06-16T22:39:52.270Z",
"modified_at": "2022-06-16T22:39:54.373Z",
"due_date": null,
"due_on": null,
"current_status_update": null,
"current_status": null,
"public": true,
"name": "My new project name",
"notes": "My new project notes\n",
"archived": false,
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace",
"name": "Prismatic"
},
"team": {
"gid": "1202178854270529",
"resource_type": "team",
"name": "Engineering"
},
"permalink_url": "https://app.asana.com/0/1202461680419124/1202461680419124",
"is_template": false,
"default_view": "board",
"start_on": null,
"color": "light-green",
"icon": "board",
"completed": false,
"completed_at": null,
"completed_by": null,
"owner": {
"gid": "1202178852626547",
"resource_type": "user",
"name": "Example User"
},
"members": [
{
"gid": "1202178852626547",
"resource_type": "user",
"name": "Example User"
}
],
"followers": [
{
"gid": "1202178852626547",
"resource_type": "user",
"name": "Example User"
}
]
}
}
}

Update Section

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202178854270533",
"resource_type": "section",
"created_at": "2022-04-25T19:28:56.749Z",
"name": "My New Section Name",
"project": {
"gid": "1202178854270532",
"resource_type": "project"
}
}
}
}

Update Tag

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461644189657",
"resource_type": "tag",
"created_at": "2022-06-16T22:04:33.095Z",
"name": "My Updated Tag Name",
"notes": "My Updated Notes",
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"color": "dark-green",
"followers": []
}
}
}

Update Task

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

Output Example Payload

{
"data": {
"data": {
"gid": "1202461395122529",
"projects": [],
"memberships": [],
"resource_type": "task",
"created_at": "2022-06-16T21:15:12.578Z",
"modified_at": "2022-06-16T21:15:14.361Z",
"name": "My new task name",
"is_rendered_as_separator": false,
"notes": "Here's my task notes!",
"assignee": {
"gid": "1202178852626547",
"resource_type": "user"
},
"completed": false,
"assignee_status": "inbox",
"completed_at": null,
"due_on": null,
"due_at": null,
"resource_subtype": "default_task",
"start_on": null,
"tags": [],
"workspace": {
"gid": "1126509132283071",
"resource_type": "workspace"
},
"num_likes": 0,
"html_notes": "<body>Here's my task notes!</body>",
"parent": null,
"liked": false,
"likes": [],
"followers": []
}
}
}