Operations (sample payloads)

Main operations
Copy

Add custom field to portfolio
Copy

Add a custom field to a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "98765432109876",
5    "portfolio_gid": "45678901234567",
6    "custom_field_gid": "78901234567890",
7    "is_important": true,
8    "portfolio_custom_field_position": {
9        "insert_after": "56789012345678"
10    }
11}

Sample Output

1{
2    "data": {
3        "gid": "89012345678901",
4        "resource_type": "portfolio_custom_field_setting",
5        "custom_field": {
6            "gid": "78901234567890",
7            "resource_type": "custom_field",
8            "created_by": {
9                "gid": "23456789012345",
10                "resource_type": "user",
11                "name": "John Doe"
12            },
13            "resource_subtype": "enum",
14            "type": "enum",
15            "name": "Project Status",
16            "enum_options": [
17                {
18                    "gid": "34567890123456",
19                    "resource_type": "enum_option",
20                    "enabled": true,
21                    "name": "Not Started",
22                    "color": "red"
23                },
24                {
25                    "gid": "45678901234567",
26                    "resource_type": "enum_option",
27                    "enabled": true,
28                    "name": "In Progress",
29                    "color": "yellow"
30                },
31                {
32                    "gid": "56789012345678",
33                    "resource_type": "enum_option",
34                    "enabled": true,
35                    "name": "Completed",
36                    "color": "green"
37                }
38            ]
39        },
40        "is_important": true,
41        "parent": {
42            "gid": "45678901234567",
43            "resource_type": "portfolio",
44            "name": "Q3 Projects"
45        }
46    }
47}

Add custom field to project
Copy

Add a custom field to a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "custom_field_gid": "34567890123456",
6    "is_important": true,
7    "project_custom_field_position": {
8        "insert_after": "45678901234567"
9    }
10}

Sample Output

1{
2    "data": {
3        "gid": "56789012345678",
4        "resource_type": "custom_field_setting",
5        "custom_field": {
6            "gid": "34567890123456",
7            "resource_type": "custom_field",
8            "created_by": {
9                "gid": "67890123456789",
10                "resource_type": "user",
11                "name": "John Doe"
12            },
13            "resource_subtype": "text",
14            "type": "text",
15            "name": "Project Status"
16        },
17        "is_important": true,
18        "parent": {
19            "gid": "23456789012345",
20            "resource_type": "project",
21            "name": "Q4 Marketing Campaign"
22        },
23        "project": {
24            "gid": "23456789012345",
25            "resource_type": "project",
26            "name": "Q4 Marketing Campaign"
27        }
28    }
29}

Add drop down option to custom field
Copy

Add an enum option to a custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "98765432109876",
5    "name": "High Priority",
6    "color": "red",
7    "enabled": true,
8    "option_position": {
9        "insert_after": "87654321098765"
10    }
11}

Sample Output

1{
2    "data": {
3        "gid": "1122334455667788",
4        "resource_type": "enum_option",
5        "enabled": true,
6        "name": "High Priority",
7        "color": "red"
8    }
9}

Add followers to a task
Copy

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

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "1234567890",
5    "task_gid": "1234567890123456",
6    "followers": [
7        "9876543210",
8        "5432109876"
9    ]
10}

Sample Output

1{
2    "data": {
3        "gid": "1234567890123456",
4        "resource_type": "task",
5        "created_at": "2023-05-15T10:30:00.000Z",
6        "modified_at": "2023-05-15T14:45:00.000Z",
7        "name": "Prepare quarterly report",
8        "notes": "Include sales figures and market analysis",
9        "assignee": {
10            "gid": "1234567890",
11            "resource_type": "user",
12            "name": "John Doe"
13        },
14        "completed": false,
15        "assignee_status": "upcoming",
16        "due_on": "2023-05-31",
17        "workspace": {
18            "gid": "12345678901234",
19            "resource_type": "workspace",
20            "name": "Marketing Team"
21        },
22        "followers": [
23            {
24                "gid": "9876543210",
25                "resource_type": "user",
26                "name": "Jane Smith"
27            },
28            {
29                "gid": "5432109876",
30                "resource_type": "user",
31                "name": "Mike Johnson"
32            }
33        ],
34        "permalink_url": "https://app.asana.com/0/1234567890123456/1234567890123456"
35    }
36}

Add members to portfolio
Copy

Add members to a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "portfolio_gid": "98765432109876",
5    "members": [
6        "1111111111111",
7        "2222222222222",
8        "3333333333333"
9    ]
10}

Sample Output

1{
2    "data": {
3        "gid": "98765432109876",
4        "resource_type": "portfolio",
5        "created_at": "2023-05-15T14:30:00.000Z",
6        "created_by": {
7            "gid": "4444444444444",
8            "resource_type": "user",
9            "name": "John Doe"
10        },
11        "owner": {
12            "gid": "5555555555555",
13            "resource_type": "user",
14            "name": "Jane Smith"
15        },
16        "name": "Q2 Projects",
17        "members": [
18            {
19                "gid": "1111111111111",
20                "resource_type": "user",
21                "name": "Alice Johnson"
22            },
23            {
24                "gid": "2222222222222",
25                "resource_type": "user",
26                "name": "Bob Williams"
27            },
28            {
29                "gid": "3333333333333",
30                "resource_type": "user",
31                "name": "Charlie Brown"
32            }
33        ],
34        "custom_field_settings": [
35            {
36                "gid": "6666666666666",
37                "resource_type": "custom_field_setting",
38                "custom_field": {
39                    "gid": "7777777777777",
40                    "resource_type": "custom_field",
41                    "created_by": "4444444444444",
42                    "resource_subtype": "enum",
43                    "type": "enum",
44                    "name": "Project Status",
45                    "enum_options": [
46                        {
47                            "gid": "8888888888888",
48                            "resource_type": "enum_option",
49                            "enabled": true,
50                            "name": "Not Started",
51                            "color": "red"
52                        },
53                        {
54                            "gid": "9999999999999",
55                            "resource_type": "enum_option",
56                            "enabled": true,
57                            "name": "In Progress",
58                            "color": "yellow"
59                        },
60                        {
61                            "gid": "1010101010101",
62                            "resource_type": "enum_option",
63                            "enabled": true,
64                            "name": "Completed",
65                            "color": "green"
66                        }
67                    ]
68                },
69                "is_important": true,
70                "parent": {
71                    "gid": "12345678901234",
72                    "resource_type": "workspace",
73                    "name": "My Workspace"
74                }
75            }
76        ],
77        "workspace": {
78            "gid": "12345678901234",
79            "resource_type": "workspace",
80            "name": "My Workspace"
81        },
82        "permalink_url": "https://app.asana.com/0/98765432109876/98765432109876",
83        "color": "light-green",
84        "due_on": "2023-06-30",
85        "start_on": "2023-04-01"
86    }
87}

Add project status update
Copy

Add a status update to a project, setting a "message" and a colour reflecting the project's status.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876",
5    "current_status": {
6        "color": "yellow",
7        "text": "Project is progressing, but we're facing some minor delays."
8    }
9}

Sample Output

1{
2    "data": {
3        "gid": "98765432109876",
4        "resource_type": "project",
5        "created_at": "2023-05-15T10:30:00.000Z",
6        "modified_at": "2023-05-15T14:45:00.000Z",
7        "due_date": null,
8        "due_on": null,
9        "public": true,
10        "name": "Q2 Marketing Campaign",
11        "notes": "This project covers our marketing efforts for Q2 2023",
12        "archived": false,
13        "workspace": {
14            "gid": "12345678901234",
15            "resource_type": "workspace",
16            "name": "Marketing Team"
17        },
18        "team": {
19            "gid": "23456789012345",
20            "resource_type": "team",
21            "name": "Digital Marketing"
22        },
23        "permalink_url": "https://app.asana.com/0/98765432109876/98765432109876",
24        "is_template": false,
25        "default_view": "list",
26        "start_on": "2023-04-01",
27        "members": [
28            {
29                "gid": "34567890123456",
30                "resource_type": "user",
31                "name": "John Doe"
32            },
33            {
34                "gid": "45678901234567",
35                "resource_type": "user",
36                "name": "Jane Smith"
37            }
38        ],
39        "color": "light-green",
40        "owner": {
41            "gid": "34567890123456",
42            "resource_type": "user",
43            "name": "John Doe"
44        },
45        "icon": "megaphone",
46        "followers": [
47            {
48                "gid": "34567890123456",
49                "resource_type": "user",
50                "name": "John Doe"
51            },
52            {
53                "gid": "45678901234567",
54                "resource_type": "user",
55                "name": "Jane Smith"
56            },
57            {
58                "gid": "56789012345678",
59                "resource_type": "user",
60                "name": "Bob Johnson"
61            }
62        ],
63        "current_status": {
64            "gid": "87654321098765",
65            "title": "Status Update",
66            "color": "yellow",
67            "text": "Project is progressing, but we're facing some minor delays.",
68            "created_by": {
69                "gid": "34567890123456",
70                "resource_type": "user",
71                "name": "John Doe"
72            },
73            "author": {
74                "gid": "34567890123456",
75                "resource_type": "user",
76                "name": "John Doe"
77            },
78            "created_at": "2023-05-15T14:45:00.000Z",
79            "modified_at": "2023-05-15T14:45:00.000Z"
80        }
81    }
82}

Add project to portfolio
Copy

Add a project to a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "portfolio_gid": "23456789012345",
5    "project_gid": "34567890123456",
6    "project_position": {
7        "insert_after": "45678901234567"
8    },
9    "owner_gid": "56789012345678"
10}

Sample Output

1{
2    "success": true
3}

Add tag to task
Copy

Add a tag to a particular task.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "1234567890",
6    "tag_gid": "9876543210"
7}

Sample Output

1{
2    "data": {
3        "gid": "1234567890",
4        "assignee": {
5            "gid": "98765432109876",
6            "resource_type": "user"
7        },
8        "assignee_status": "inbox",
9        "completed": false,
10        "completed_at": null,
11        "created_at": "2023-05-15T10:30:00.000Z",
12        "custom_fields": [
13            {
14                "gid": "987654321",
15                "enabled": true,
16                "enum_options": [
17                    {
18                        "gid": "123456789",
19                        "color": "blue",
20                        "enabled": true,
21                        "name": "High",
22                        "resource_type": "enum_option"
23                    }
24                ],
25                "enum_value": {
26                    "gid": "123456789",
27                    "color": "blue",
28                    "enabled": true,
29                    "name": "High",
30                    "resource_type": "enum_option"
31                },
32                "name": "Priority",
33                "created_by": {
34                    "gid": "11223344556677",
35                    "name": "John Doe",
36                    "resource_type": "user"
37                },
38                "display_value": "High",
39                "resource_subtype": "enum",
40                "resource_type": "custom_field",
41                "type": "enum"
42            }
43        ],
44        "due_at": null,
45        "due_on": "2023-05-22",
46        "followers": [
47            {
48                "gid": "98765432109876",
49                "resource_type": "user"
50            }
51        ],
52        "hearted": false,
53        "hearts": [],
54        "html_notes": "<body>Complete project documentation</body>",
55        "memberships": [
56            {
57                "project": {
58                    "gid": "1122334455",
59                    "resource_type": "project"
60                },
61                "section": {
62                    "gid": "5566778899",
63                    "resource_type": "section"
64                }
65            }
66        ],
67        "modified_at": "2023-05-15T14:45:00.000Z",
68        "name": "Write project documentation",
69        "notes": "Complete project documentation",
70        "num_hearts": 0,
71        "parent": null,
72        "projects": [
73            {
74                "gid": "1122334455",
75                "resource_type": "project"
76            }
77        ],
78        "start_on": null,
79        "tags": [
80            {
81                "gid": "9876543210",
82                "resource_type": "tag"
83            }
84        ],
85        "workspace": {
86            "gid": "12345678901234",
87            "resource_type": "workspace"
88        }
89    }
90}

Add task dependencies
Copy

Add dependencies to a task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "dependencies": [
7        "76543210987654",
8        "65432109876543"
9    ]
10}

Sample Output

1{
2    "success": true
3}

Add task to project
Copy

Add a task to a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "task_gid": "34567890123456",
6    "section_gid": "45678901234567",
7    "assignee_gid": "56789012345678"
8}

Sample Output

1{
2    "data": {
3        "gid": "23456789012345",
4        "archived": false,
5        "color": "light-green",
6        "created_at": "2023-05-15T10:30:00.000Z",
7        "current_status": {
8            "gid": "67890123456789",
9            "author": {
10                "gid": "78901234567890",
11                "name": "John Doe",
12                "resource_type": "user"
13            },
14            "color": "green",
15            "created_at": "2023-05-15T10:35:00.000Z",
16            "created_by": {
17                "gid": "78901234567890",
18                "name": "John Doe",
19                "resource_type": "user"
20            },
21            "modified_at": "2023-05-15T10:35:00.000Z",
22            "resource_type": "project_status",
23            "text": "Project is on track",
24            "title": "On Track"
25        },
26        "custom_fields": [
27            {
28                "gid": "89012345678901",
29                "enabled": true,
30                "name": "Priority",
31                "created_by": {
32                    "gid": "90123456789012",
33                    "name": "Jane Smith",
34                    "resource_type": "user"
35                },
36                "display_value": "High",
37                "resource_subtype": "enum",
38                "resource_type": "custom_field",
39                "text_value": "High",
40                "type": "enum"
41            }
42        ],
43        "custom_field_settings": [
44            {
45                "gid": "01234567890123",
46                "custom_field": {
47                    "gid": "89012345678901",
48                    "name": "Priority",
49                    "resource_subtype": "enum",
50                    "resource_type": "custom_field",
51                    "type": "enum"
52                },
53                "is_important": true,
54                "parent": {
55                    "gid": "23456789012345",
56                    "name": "Project Alpha",
57                    "resource_type": "project"
58                },
59                "project": {
60                    "gid": "23456789012345",
61                    "name": "Project Alpha",
62                    "resource_type": "project"
63                },
64                "resource_type": "custom_field_setting"
65            }
66        ],
67        "default_view": "list",
68        "due_on": "2023-06-30",
69        "due_date": "2023-06-30",
70        "followers": [
71            {
72                "gid": "12345678901234",
73                "name": "Alice Johnson",
74                "resource_type": "user"
75            },
76            {
77                "gid": "23456789012345",
78                "name": "Bob Williams",
79                "resource_type": "user"
80            }
81        ],
82        "is_template": false,
83        "members": [
84            {
85                "gid": "34567890123456",
86                "name": "Charlie Brown",
87                "resource_type": "user"
88            },
89            {
90                "gid": "45678901234567",
91                "name": "Diana Prince",
92                "resource_type": "user"
93            }
94        ],
95        "modified_at": "2023-05-15T10:40:00.000Z",
96        "name": "Project Alpha",
97        "notes": "This project aims to improve our product's user interface.",
98        "owner": {
99            "gid": "56789012345678",
100            "name": "Eve Anderson",
101            "resource_type": "user"
102        },
103        "permalink_url": "https://app.asana.com/0/23456789012345/23456789012345",
104        "public": false,
105        "resource_type": "project",
106        "start_on": "2023-05-01",
107        "team": {
108            "gid": "67890123456789",
109            "name": "Product Team",
110            "resource_type": "team"
111        },
112        "workspace": {
113            "gid": "78901234567890",
114            "name": "Acme Corp",
115            "resource_type": "workspace"
116        }
117    }
118}

Add task to section
Copy

Add a task to a section.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "section_gid": "34567890123456",
6    "assignee_gid": "45678901234567",
7    "task_gid": "56789012345678",
8    "section_position": {
9        "insert_after": "67890123456789"
10    }
11}

Sample Output

1{
2    "success": true
3}

Copy all project custom fields
Copy

Copy all custom fields from a source project to a destination project. This is operation is only available to premium Asana accounts.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234567",
4    "organization_gid": "98765432109876543",
5    "team_gid": "45678901234567890",
6    "source_project_gid": "1122334455667788",
7    "destination_project_gid": "8877665544332211"
8}

Sample Output

1{
2    "fieldsCopied": 5,
3    "fieldsNotCopied": 1,
4    "errors": [
5        "Custom field 'Priority' could not be copied due to insufficient permissions"
6    ]
7}

Copy all tasks
Copy

Copy all tasks from one project to another, including those that are marked completed and archived in the source.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "source_project_gid": "98765432109876",
5    "destination_project_gid": "45678901234567",
6    "delete_existing": true,
7    "include": {
8        "assignee": true,
9        "subtasks": true,
10        "tags": true,
11        "followers": false,
12        "projects": false,
13        "custom_fields": true,
14        "due_date": true
15    }
16}

Sample Output

1{
2    "success": true,
3    "tasksCopied": 42
4}

Copy task
Copy

Copy a task, copying over the description, followers, and assignee, along with subtasks and custom field settings.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "1234567890123456",
6    "new_name": "Copied Task: Project Kickoff Meeting",
7    "task_resource_subtype": "default_task",
8    "include": {
9        "assignee": true,
10        "subtasks": true,
11        "tags": true,
12        "followers": true,
13        "projects": true,
14        "custom_fields": true,
15        "due_date": true,
16        "parent": false
17    }
18}

Sample Output

1{
2    "success": true,
3    "data": {
4        "gid": "2345678901234567",
5        "projects": [
6            {
7                "gid": "3456789012345678",
8                "resource_type": "project",
9                "name": "Q3 Marketing Campaign"
10            }
11        ],
12        "resource_type": "task",
13        "created_at": "2023-06-15T10:30:00.000Z",
14        "modified_at": "2023-06-15T10:30:00.000Z",
15        "name": "Copied Task: Project Kickoff Meeting",
16        "notes": "Prepare agenda and materials for the project kickoff meeting.",
17        "assignee": {
18            "gid": "98765432109876",
19            "resource_type": "user",
20            "name": "Jane Doe"
21        },
22        "completed": false,
23        "assignee_status": "upcoming",
24        "completed_at": null,
25        "due_on": "2023-06-20",
26        "due_at": null,
27        "resource_subtype": "default_task",
28        "start_on": "2023-06-18",
29        "tags": [
30            {
31                "gid": "4567890123456789",
32                "resource_type": "tag",
33                "name": "High Priority"
34            }
35        ],
36        "workspace": {
37            "gid": "12345678901234",
38            "resource_type": "workspace",
39            "name": "Marketing Team"
40        },
41        "num_hearts": 0,
42        "num_likes": 0,
43        "permalink_url": "https://app.asana.com/0/2345678901234567/2345678901234567",
44        "followers": [
45            {
46                "gid": "5678901234567890",
47                "resource_type": "user",
48                "name": "John Smith"
49            }
50        ],
51        "parent": null,
52        "hearted": false,
53        "hearts": [],
54        "liked": false,
55        "likes": [],
56        "memberships": [
57            {
58                "project": {
59                    "gid": "3456789012345678",
60                    "resource_type": "project",
61                    "name": "Q3 Marketing Campaign"
62                },
63                "section": {
64                    "gid": "6789012345678901",
65                    "resource_type": "section",
66                    "name": "To Do"
67                }
68            }
69        ],
70        "custom_fields": [
71            {
72                "gid": "7890123456789012",
73                "resource_type": "custom_field",
74                "created_by": {
75                    "gid": "8901234567890123",
76                    "resource_type": "user",
77                    "name": "Admin User"
78                },
79                "resource_subtype": "text",
80                "type": "text",
81                "name": "Status",
82                "enabled": true,
83                "text_value": "Not Started"
84            }
85        ]
86    }
87}

Create custom field
Copy

Create a new custom field.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "name": "Priority",
5    "description": "Indicates the priority level of the task",
6    "custom_field_resource_subtype": {
7        "drop_down": {
8            "options": [
9                {
10                    "name": "Low",
11                    "color": "light-green"
12                },
13                {
14                    "name": "Medium",
15                    "color": "yellow"
16                },
17                {
18                    "name": "High",
19                    "color": "red"
20                }
21            ]
22        }
23    }
24}

Sample Output

1{
2    "data": {
3        "gid": "1201234567890123",
4        "resource_type": "custom_field",
5        "resource_subtype": "enum",
6        "type": "enum",
7        "name": "Priority",
8        "description": "Indicates the priority level of the task",
9        "is_global_to_workspace": true,
10        "created_by": {
11            "gid": "9876543210987654",
12            "resource_type": "user",
13            "name": "John Doe"
14        }
15    }
16}

Create membership
Copy

Create a new membership in a goal or project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "parent_gid": "1234567890",
4    "membership_gid": "9876543210",
5    "opt_pretty": true,
6    "access_level": "editor"
7}

Sample Output

1{
2    "data": {
3        "gid": "1122334455",
4        "resource_subtype": "membership",
5        "resource_type": "membership",
6        "access_level": "editor",
7        "parent": {
8            "gid": "1234567890",
9            "resource_type": "project",
10            "name": "Q4 Marketing Campaign"
11        },
12        "member": {
13            "gid": "9876543210",
14            "resource_type": "user",
15            "name": "John Doe"
16        }
17    }
18}

Create portfolio
Copy

Create a new portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "name": "Q4 2023 Projects",
5    "color": "light-green"
6}

Sample Output

1{
2    "data": {
3        "gid": "1201234567890123",
4        "resource_type": "portfolio",
5        "created_at": "2023-06-15T14:30:00.000Z",
6        "name": "Q4 2023 Projects",
7        "workspace": {
8            "gid": "12345678901234",
9            "resource_type": "workspace",
10            "name": "My Company Workspace"
11        },
12        "permalink_url": "https://app.asana.com/0/portfolio/1201234567890123",
13        "color": "light-green",
14        "due_on": null,
15        "start_on": null,
16        "created_by": {
17            "gid": "1234567890",
18            "resource_type": "user",
19            "name": "John Doe"
20        },
21        "members": [
22            {
23                "gid": "1234567890",
24                "resource_type": "user",
25                "name": "John Doe"
26            }
27        ],
28        "custom_field_settings": [],
29        "owner": {
30            "gid": "1234567890",
31            "resource_type": "user",
32            "name": "John Doe"
33        }
34    }
35}

Create project
Copy

Create a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "name": "Q4 Marketing Campaign",
4    "workspace_gid": "12345678901234",
5    "organization_gid": "98765432109876",
6    "team_gid": "45678901234567",
7    "owner_gid": "78901234567890",
8    "current_status": {
9        "color": "green",
10        "text": "On track"
11    },
12    "start_on": "2023-10-01",
13    "due_on": "2023-12-31",
14    "archived": false,
15    "privacy_setting": "private_to_team",
16    "color": "light-green",
17    "notes": "This project covers all marketing activities for Q4, including social media campaigns, email marketing, and content creation.",
18    "layout": "board"
19}

Sample Output

1{
2    "data": {
3        "gid": "1201234567890123",
4        "resource_type": "project",
5        "created_at": "2023-09-15T14:30:00.000Z",
6        "modified_at": "2023-09-15T14:30:00.000Z",
7        "owner": {
8            "gid": "78901234567890",
9            "resource_type": "user",
10            "name": "John Doe"
11        },
12        "due_date": null,
13        "due_on": "2023-12-31",
14        "public": false,
15        "privacy_setting": "private_to_team",
16        "name": "Q4 Marketing Campaign",
17        "notes": "This project covers all marketing activities for Q4, including social media campaigns, email marketing, and content creation.",
18        "archived": false,
19        "workspace": {
20            "gid": "12345678901234",
21            "resource_type": "workspace",
22            "name": "Marketing Team Workspace"
23        },
24        "team": {
25            "gid": "45678901234567",
26            "resource_type": "team",
27            "name": "Marketing Team"
28        },
29        "permalink_url": "https://app.asana.com/0/1201234567890123/1201234567890123",
30        "is_template": false,
31        "default_view": "board",
32        "start_on": "2023-10-01",
33        "color": "light-green",
34        "icon": "clipboard",
35        "current_status": {
36            "gid": "1301234567890123",
37            "title": "On track",
38            "color": "green",
39            "text": "On track",
40            "created_at": "2023-09-15T14:30:00.000Z",
41            "modified_at": "2023-09-15T14:30:00.000Z",
42            "created_by": {
43                "gid": "78901234567890",
44                "resource_type": "user",
45                "name": "John Doe"
46            },
47            "author": {
48                "gid": "78901234567890",
49                "resource_type": "user",
50                "name": "John Doe"
51            }
52        },
53        "custom_field_settings": [],
54        "custom_fields": [],
55        "members": [
56            {
57                "gid": "78901234567890",
58                "resource_type": "user",
59                "name": "John Doe"
60            }
61        ],
62        "followers": [
63            {
64                "gid": "78901234567890",
65                "resource_type": "user",
66                "name": "John Doe"
67            }
68        ]
69    }
70}

Create project section
Copy

Create a project section.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "name": "New Development Phase",
6    "section_position": {
7        "insert_after": "34567890123456"
8    }
9}

Sample Output

1{
2    "data": {
3        "gid": "45678901234567",
4        "resource_type": "section",
5        "created_at": "2023-05-15T14:30:00.000Z",
6        "name": "New Development Phase",
7        "project": {
8            "gid": "23456789012345",
9            "resource_type": "project",
10            "name": "Product Launch 2023"
11        }
12    }
13}

Create subtask
Copy

Create a subtask.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "task_gid": "98765432109876",
5    "name": "Review documentation",
6    "notes": "Please review the latest changes to the user guide.",
7    "due_on": "2023-06-30",
8    "new_assignee_gid": "1357924680",
9    "projects": [
10        "24681357902"
11    ],
12    "tags": [
13        "987654321"
14    ],
15    "followers": [
16        "2468013579"
17    ],
18    "completed": false,
19    "liked": true,
20    "custom_fields": [
21        {
22            "custom_field_gid": "11223344556677",
23            "value": "High"
24        }
25    ]
26}

Sample Output

1{
2    "data": {
3        "gid": "1122334455667788",
4        "resource_type": "task",
5        "created_at": "2023-06-15T10:30:00.000Z",
6        "modified_at": "2023-06-15T10:30:00.000Z",
7        "name": "Review documentation",
8        "notes": "Please review the latest changes to the user guide.",
9        "assignee": {
10            "gid": "1357924680",
11            "resource_type": "user",
12            "name": "John Doe"
13        },
14        "completed": false,
15        "assignee_status": "inbox",
16        "completed_at": null,
17        "due_on": "2023-06-30",
18        "due_at": null,
19        "resource_subtype": "default_task",
20        "start_on": null,
21        "tags": [
22            {
23                "gid": "987654321",
24                "resource_type": "tag",
25                "name": "Documentation"
26            }
27        ],
28        "workspace": {
29            "gid": "12345678901234",
30            "resource_type": "workspace",
31            "name": "My Workspace"
32        },
33        "num_hearts": 0,
34        "num_likes": 1,
35        "permalink_url": "https://app.asana.com/0/1122334455667788/1122334455667788",
36        "parent": {
37            "gid": "98765432109876",
38            "resource_type": "task",
39            "name": "Update User Guide",
40            "resource_subtype": "default_task"
41        },
42        "hearted": false,
43        "hearts": [],
44        "liked": true,
45        "likes": [
46            {
47                "gid": "9988776655",
48                "user": {
49                    "gid": "1357924680",
50                    "resource_type": "user",
51                    "name": "John Doe"
52                }
53            }
54        ],
55        "projects": [
56            {
57                "gid": "24681357902",
58                "resource_type": "project",
59                "name": "Documentation Project"
60            }
61        ],
62        "memberships": [
63            {
64                "project": {
65                    "gid": "24681357902",
66                    "resource_type": "project",
67                    "name": "Documentation Project"
68                },
69                "section": {
70                    "gid": "3344556677",
71                    "resource_type": "section",
72                    "name": "In Progress"
73                }
74            }
75        ],
76        "followers": [
77            {
78                "gid": "2468013579",
79                "resource_type": "user",
80                "name": "Jane Smith"
81            }
82        ],
83        "custom_fields": [
84            {
85                "gid": "11223344556677",
86                "resource_type": "custom_field",
87                "created_by": {
88                    "gid": "9876543210",
89                    "resource_type": "user",
90                    "name": "Admin User"
91                },
92                "resource_subtype": "enum",
93                "type": "enum",
94                "name": "Priority",
95                "enabled": true,
96                "precision": 0,
97                "text_value": "High"
98            }
99        ]
100    }
101}

Create tag
Copy

Create a new tag in a workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "name": "Project Alpha",
5    "color": "dark-blue",
6    "followers": [
7        "987654321098",
8        "876543210987"
9    ]
10}

Sample Output

1{
2    "data": {
3        "gid": "1201234567890123",
4        "resource_type": "tag",
5        "created_at": "2023-05-15T14:30:00.000Z",
6        "name": "Project Alpha",
7        "notes": "",
8        "workspace": {
9            "gid": "12345678901234",
10            "resource_type": "workspace",
11            "name": "My Workspace"
12        },
13        "permalink_url": "https://app.asana.com/0/1201234567890123/1201234567890123",
14        "color": "dark-blue",
15        "followers": [
16            {
17                "gid": "987654321098",
18                "resource_type": "user",
19                "name": "John Doe"
20            },
21            {
22                "gid": "876543210987",
23                "resource_type": "user",
24                "name": "Jane Smith"
25            }
26        ]
27    }
28}

Create task
Copy

Create a new task.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "name": "Prepare quarterly report",
5    "assignee_gid": "98765432109876",
6    "task_resource_subtype": "default_task",
7    "notes": "Compile financial data and create presentation for Q2 results",
8    "projects": [
9        "23456789012345",
10        "34567890123456"
11    ],
12    "tags": [
13        "56789012345678",
14        "67890123456789"
15    ],
16    "assignee_status": "upcoming",
17    "due_on": "2023-07-15",
18    "start_on": "2023-07-01",
19    "followers": [
20        "45678901234567",
21        "56789012345678"
22    ],
23    "completed": false,
24    "custom_fields": [
25        {
26            "custom_field_gid": "78901234567890",
27            "value": "High"
28        }
29    ],
30    "memberships": [
31        {
32            "project": "23456789012345",
33            "section": "89012345678901"
34        }
35    ],
36    "liked": true
37}

Sample Output

1{
2    "data": {
3        "gid": "1234567890123456",
4        "resource_type": "task",
5        "created_at": "2023-06-15T10:30:00.000Z",
6        "modified_at": "2023-06-15T10:30:00.000Z",
7        "name": "Prepare quarterly report",
8        "notes": "Compile financial data and create presentation for Q2 results",
9        "completed": false,
10        "assignee_status": "upcoming",
11        "completed_at": null,
12        "due_on": "2023-07-15",
13        "start_on": "2023-07-01",
14        "resource_subtype": "default_task",
15        "tags": [
16            {
17                "gid": "56789012345678",
18                "resource_type": "tag",
19                "name": "Finance"
20            },
21            {
22                "gid": "67890123456789",
23                "resource_type": "tag",
24                "name": "Quarterly"
25            }
26        ],
27        "workspace": {
28            "gid": "12345678901234",
29            "resource_type": "workspace",
30            "name": "My Company"
31        },
32        "num_hearts": 0,
33        "num_likes": 1,
34        "permalink_url": "https://app.asana.com/0/12345678901234/1234567890123456",
35        "assignee": {
36            "gid": "98765432109876",
37            "resource_type": "user",
38            "name": "John Doe"
39        },
40        "hearted": false,
41        "hearts": [],
42        "followers": [
43            {
44                "gid": "45678901234567",
45                "resource_type": "user",
46                "name": "Jane Smith"
47            },
48            {
49                "gid": "56789012345678",
50                "resource_type": "user",
51                "name": "Mike Johnson"
52            }
53        ],
54        "liked": true,
55        "likes": [
56            {
57                "gid": "2345678901234567",
58                "user": {
59                    "gid": "98765432109876",
60                    "resource_type": "user",
61                    "name": "John Doe"
62                }
63            }
64        ],
65        "memberships": [
66            {
67                "project": {
68                    "gid": "23456789012345",
69                    "resource_type": "project",
70                    "name": "Q2 Reporting"
71                },
72                "section": {
73                    "gid": "89012345678901",
74                    "resource_type": "section",
75                    "name": "In Progress"
76                }
77            },
78            {
79                "project": {
80                    "gid": "34567890123456",
81                    "resource_type": "project",
82                    "name": "Finance Department"
83                }
84            }
85        ],
86        "custom_fields": [
87            {
88                "gid": "78901234567890",
89                "resource_type": "custom_field",
90                "created_by": {
91                    "gid": "34567890123456",
92                    "resource_type": "user",
93                    "name": "Admin User"
94                },
95                "resource_subtype": "enum",
96                "type": "enum",
97                "name": "Priority",
98                "enabled": true,
99                "text_value": "High"
100            }
101        ],
102        "projects": [
103            {
104                "gid": "23456789012345",
105                "resource_type": "project",
106                "name": "Q2 Reporting"
107            },
108            {
109                "gid": "34567890123456",
110                "resource_type": "project",
111                "name": "Finance Department"
112            }
113        ]
114    }
115}

Create task comment
Copy

Add a comment to a task. Comments will appear in the Asana UI to be from the Asana user connected with your tray account.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "1234567890",
5    "task_gid": "9876543210",
6    "comment": {
7        "text": "Great progress on this task! Let's schedule a quick call to discuss the next steps."
8    },
9    "is_pinned": true
10}

Sample Output

1{
2    "data": {
3        "gid": "1234567890123456",
4        "resource_type": "story",
5        "created_at": "2023-05-15T14:30:00.000Z",
6        "source": "api",
7        "is_pinned": true,
8        "type": "comment",
9        "text": "Great progress on this task! Let's schedule a quick call to discuss the next steps.",
10        "is_edited": false,
11        "resource_subtype": "comment_added",
12        "num_hearts": 0,
13        "num_likes": 0,
14        "created_by": {
15            "gid": "1234567890",
16            "resource_type": "user",
17            "name": "John Doe"
18        },
19        "is_editable": true,
20        "hearted": false,
21        "hearts": [],
22        "previews": [],
23        "liked": false,
24        "likes": [],
25        "target": {
26            "gid": "9876543210",
27            "resource_type": "task",
28            "name": "Implement new feature",
29            "resource_subtype": "default_task"
30        }
31    }
32}

Delete custom field
Copy

Delete a custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "987654321098765"
5}

Sample Output

1{
2    "existed": true,
3    "deleted": true
4}

Delete membership
Copy

Delete a membership for a goal or project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "membership_gid": "12345678901234",
4    "opt_pretty": true
5}

Sample Output

1{
2    "success": true,
3    "message": "Membership successfully deleted"
4}

Delete portfolio
Copy

Delete a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "98765432109876",
5    "portfolio_gid": "45678901234567"
6}

Sample Output

1{
2    "existed": true,
3    "deleted": true
4}

Delete project
Copy

Delete a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876"
5}

Sample Output

1{
2    "existed": true,
3    "deleted": true
4}

Delete section
Copy

Delete a section.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "section_gid": "34567890123456"
6}

Sample Output

1{
2    "existed": true,
3    "deleted": true
4}

Delete task
Copy

Delete a task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "1234567890123456"
6}

Sample Output

1{
2    "existed": true,
3    "deleted": true
4}

Download attachments
Copy

Download task attachments hosted on Asana. Maximum total size of attachments is 500MB.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "attachment_gids": [
4        {
5            "gid": "1201234567890123"
6        },
7        {
8            "gid": "1201234567890124"
9        }
10    ]
11}

Sample Output

1{
2    "files": [
3        {
4            "name": "project_proposal.pdf",
5            "url": "https://s3.amazonaws.com/asana-attachments/1201234567890123/project_proposal.pdf",
6            "mime_type": "application/pdf",
7            "expires": 1623456789,
8            "error": false,
9            "file_gid": "1201234567890123"
10        },
11        {
12            "name": "meeting_notes.docx",
13            "url": "https://s3.amazonaws.com/asana-attachments/1201234567890124/meeting_notes.docx",
14            "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
15            "expires": 1623456789,
16            "error": false,
17            "file_gid": "1201234567890124"
18        }
19    ]
20}

Get attachment
Copy

Get the full record for a single attachment.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "gid": "1234567890123456"
4}

Sample Output

1{
2    "data": {
3        "gid": "1234567890123456",
4        "created_at": "2023-05-15T14:30:00.000Z",
5        "download_url": "https://app.asana.com/app/attachments/1234567890123456/download",
6        "host": "asana",
7        "name": "project_report.pdf",
8        "parent": {
9            "gid": "9876543210987654",
10            "name": "Q2 Project Updates",
11            "resource_type": "task"
12        },
13        "permanent_url": "https://app.asana.com/0/0/1234567890123456",
14        "resource_type": "attachment",
15        "resource_subtype": "pdf",
16        "view_url": "https://app.asana.com/app/attachments/1234567890123456/view"
17    }
18}

Get custom field
Copy

Return all metadata for a specified custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "9876543210987"
5}

Sample Output

1{
2    "data": {
3        "gid": "9876543210987",
4        "enum_options": [
5            {
6                "gid": "1234567890123",
7                "color": "blue",
8                "enabled": true,
9                "name": "Low",
10                "resource_type": "enum_option"
11            },
12            {
13                "gid": "2345678901234",
14                "color": "yellow",
15                "enabled": true,
16                "name": "Medium",
17                "resource_type": "enum_option"
18            },
19            {
20                "gid": "3456789012345",
21                "color": "red",
22                "enabled": true,
23                "name": "High",
24                "resource_type": "enum_option"
25            }
26        ],
27        "has_notifications_enabled": false,
28        "name": "Priority",
29        "created_by": "5678901234567",
30        "resource_subtype": "enum",
31        "resource_type": "custom_field",
32        "type": "enum",
33        "is_global_to_workspace": true
34    }
35}

Get portfolio
Copy

Return data for a specified portfolio.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "portfolio_gid": "98765432109876"
5}

Sample Output

1{
2    "data": {
3        "gid": "98765432109876",
4        "color": "light-green",
5        "created_at": "2023-05-15T10:30:00.000Z",
6        "created_by": {
7            "gid": "1234567890",
8            "name": "John Doe",
9            "resource_type": "user"
10        },
11        "custom_field_settings": [
12            {
13                "gid": "987654321",
14                "custom_field": {
15                    "gid": "456789012",
16                    "enum_options": [
17                        {
18                            "gid": "345678901",
19                            "color": "blue",
20                            "enabled": true,
21                            "name": "High",
22                            "resource_type": "enum_option"
23                        },
24                        {
25                            "gid": "234567890",
26                            "color": "yellow",
27                            "enabled": true,
28                            "name": "Medium",
29                            "resource_type": "enum_option"
30                        },
31                        {
32                            "gid": "123456789",
33                            "color": "green",
34                            "enabled": true,
35                            "name": "Low",
36                            "resource_type": "enum_option"
37                        }
38                    ],
39                    "name": "Priority",
40                    "resource_subtype": "enum",
41                    "resource_type": "custom_field",
42                    "type": "enum"
43                },
44                "is_important": true,
45                "parent": {
46                    "gid": "876543210",
47                    "name": "Project Management",
48                    "resource_type": "portfolio"
49                },
50                "resource_type": "custom_field_setting"
51            }
52        ],
53        "due_on": "2023-12-31",
54        "members": [
55            {
56                "gid": "2345678901",
57                "name": "Jane Smith",
58                "resource_type": "user"
59            },
60            {
61                "gid": "3456789012",
62                "name": "Mike Johnson",
63                "resource_type": "user"
64            }
65        ],
66        "name": "Q4 Projects",
67        "owner": {
68            "gid": "1234567890",
69            "name": "John Doe",
70            "resource_type": "user"
71        },
72        "permalink_url": "https://app.asana.com/0/98765432109876/98765432109876",
73        "resource_type": "portfolio",
74        "start_on": "2023-10-01",
75        "workspace": {
76            "gid": "12345678901234",
77            "name": "My Company Workspace",
78            "resource_type": "workspace"
79        }
80    }
81}

Get project
Copy

Find a project in an Asana workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "1234567890123456"
5}

Sample Output

1{
2    "data": {
3        "gid": "1234567890123456",
4        "archived": false,
5        "color": "light-green",
6        "created_at": "2023-05-15T10:30:00.000Z",
7        "current_status": {
8            "gid": "9876543210987654",
9            "author": {
10                "gid": "5678901234567890",
11                "name": "John Doe",
12                "resource_type": "user"
13            },
14            "color": "green",
15            "created_at": "2023-05-20T14:45:00.000Z",
16            "created_by": {
17                "gid": "5678901234567890",
18                "name": "John Doe",
19                "resource_type": "user"
20            },
21            "modified_at": "2023-05-20T14:45:00.000Z",
22            "resource_type": "project_status",
23            "text": "Project is on track",
24            "title": "On Track"
25        },
26        "custom_fields": [
27            {
28                "gid": "1357924680123456",
29                "enabled": true,
30                "name": "Priority",
31                "created_by": {
32                    "gid": "2468013579246801",
33                    "name": "Jane Smith",
34                    "resource_type": "user"
35                },
36                "display_value": "High",
37                "resource_subtype": "enum",
38                "resource_type": "custom_field",
39                "text_value": "High",
40                "type": "enum"
41            }
42        ],
43        "default_view": "list",
44        "due_on": "2023-06-30",
45        "due_date": "2023-06-30",
46        "followers": [
47            {
48                "gid": "5678901234567890",
49                "name": "John Doe",
50                "resource_type": "user"
51            },
52            {
53                "gid": "2468013579246801",
54                "name": "Jane Smith",
55                "resource_type": "user"
56            }
57        ],
58        "is_template": false,
59        "members": [
60            {
61                "gid": "5678901234567890",
62                "name": "John Doe",
63                "resource_type": "user"
64            },
65            {
66                "gid": "2468013579246801",
67                "name": "Jane Smith",
68                "resource_type": "user"
69            }
70        ],
71        "modified_at": "2023-05-22T09:15:00.000Z",
72        "name": "Q2 Marketing Campaign",
73        "notes": "This project aims to increase brand awareness and generate leads through various marketing channels.",
74        "owner": {
75            "gid": "5678901234567890",
76            "name": "John Doe",
77            "resource_type": "user"
78        },
79        "permalink_url": "https://app.asana.com/0/1234567890123456/1234567890123456",
80        "public": false,
81        "resource_type": "project",
82        "start_on": "2023-04-01",
83        "team": {
84            "gid": "3692581470123456",
85            "name": "Marketing Team",
86            "resource_type": "team"
87        },
88        "workspace": {
89            "gid": "12345678901234",
90            "name": "My Company",
91            "resource_type": "workspace"
92        }
93    }
94}

Get section
Copy

Get a section from your Asana account.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "section_gid": "34567890123456"
6}

Sample Output

1{
2    "data": {
3        "gid": "34567890123456",
4        "created_at": "2023-05-15T10:30:00.000Z",
5        "name": "To Do",
6        "project": {
7            "gid": "23456789012345",
8            "name": "Project Alpha",
9            "resource_type": "project"
10        },
11        "resource_type": "section"
12    }
13}

Get task
Copy

Find a task by its GID.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "56789012345678",
5    "task_gid": "98765432109876"
6}

Sample Output

1{
2    "data": {
3        "gid": "98765432109876",
4        "assignee": {
5            "gid": "56789012345678",
6            "resource_type": "user"
7        },
8        "assignee_status": "inbox",
9        "completed": false,
10        "completed_at": null,
11        "created_at": "2023-05-15T10:30:00.000Z",
12        "custom_fields": [
13            {
14                "gid": "1234567890",
15                "enabled": true,
16                "enum_options": [
17                    {
18                        "gid": "1111111111",
19                        "color": "blue",
20                        "enabled": true,
21                        "name": "Low",
22                        "resource_type": "enum_option"
23                    },
24                    {
25                        "gid": "2222222222",
26                        "color": "yellow",
27                        "enabled": true,
28                        "name": "Medium",
29                        "resource_type": "enum_option"
30                    },
31                    {
32                        "gid": "3333333333",
33                        "color": "red",
34                        "enabled": true,
35                        "name": "High",
36                        "resource_type": "enum_option"
37                    }
38                ],
39                "enum_value": {
40                    "gid": "2222222222",
41                    "color": "yellow",
42                    "enabled": true,
43                    "name": "Medium",
44                    "resource_type": "enum_option"
45                },
46                "name": "Priority",
47                "created_by": {
48                    "gid": "9876543210",
49                    "name": "John Doe",
50                    "resource_type": "user"
51                },
52                "display_value": "Medium",
53                "resource_subtype": "enum",
54                "resource_type": "custom_field",
55                "type": "enum"
56            }
57        ],
58        "due_on": "2023-05-22",
59        "followers": [
60            {
61                "gid": "1357924680",
62                "resource_type": "user"
63            }
64        ],
65        "hearted": false,
66        "hearts": [],
67        "html_notes": "<body>This is a sample task description with <b>HTML formatting</b>.</body>",
68        "memberships": [
69            {
70                "project": {
71                    "gid": "2468135790",
72                    "resource_type": "project"
73                },
74                "section": {
75                    "gid": "1357924680",
76                    "resource_type": "section"
77                }
78            }
79        ],
80        "modified_at": "2023-05-16T14:45:00.000Z",
81        "name": "Sample Task",
82        "notes": "This is a sample task description.",
83        "num_hearts": 0,
84        "projects": [
85            {
86                "gid": "2468135790",
87                "resource_type": "project"
88            }
89        ],
90        "tags": [
91            {
92                "gid": "9876543210",
93                "resource_type": "tag"
94            }
95        ],
96        "workspace": {
97            "gid": "12345678901234",
98            "resource_type": "workspace"
99        }
100    }
101}

Get team
Copy

Return information about a team.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "organization_gid": "1234567890",
4    "team_gid": "9876543210"
5}

Sample Output

1{
2    "data": {
3        "gid": "9876543210",
4        "description": "This team is responsible for product development and innovation.",
5        "name": "Product Development Team",
6        "organization": {
7            "gid": "1234567890",
8            "resource_type": "organization"
9        }
10    }
11}

Get user
Copy

Return information about a user.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "user_gid": "9876543210987"
5}

Sample Output

1{
2    "data": {
3        "gid": "9876543210987",
4        "email": "john.doe@example.com",
5        "name": "John Doe",
6        "photo": {
7            "image_128x128": "https://s3.amazonaws.com/profile_photos/128x128/john_doe_128.jpg",
8            "image_21x21": "https://s3.amazonaws.com/profile_photos/21x21/john_doe_21.jpg",
9            "image_27x27": "https://s3.amazonaws.com/profile_photos/27x27/john_doe_27.jpg",
10            "image_36x36": "https://s3.amazonaws.com/profile_photos/36x36/john_doe_36.jpg",
11            "image_60x60": "https://s3.amazonaws.com/profile_photos/60x60/john_doe_60.jpg"
12        },
13        "workspaces": [
14            {
15                "gid": "12345678901234",
16                "resource_type": "workspace"
17            },
18            {
19                "gid": "23456789012345",
20                "resource_type": "workspace"
21            }
22        ]
23    }
24}

Get user by email
Copy

Return information about a user.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "email": "john.doe@example.com"
5}

Sample Output

1{
2    "data": {
3        "gid": "1234567890",
4        "email": "john.doe@example.com",
5        "name": "John Doe",
6        "photo": {
7            "image_128x128": "https://s3.amazonaws.com/profile_photos/1234567890.128x128.jpg",
8            "image_21x21": "https://s3.amazonaws.com/profile_photos/1234567890.21x21.jpg",
9            "image_27x27": "https://s3.amazonaws.com/profile_photos/1234567890.27x27.jpg",
10            "image_36x36": "https://s3.amazonaws.com/profile_photos/1234567890.36x36.jpg",
11            "image_60x60": "https://s3.amazonaws.com/profile_photos/1234567890.60x60.jpg"
12        },
13        "workspaces": [
14            {
15                "gid": "12345678901234",
16                "resource_type": "workspace"
17            },
18            {
19                "gid": "23456789012345",
20                "resource_type": "workspace"
21            }
22        ]
23    }
24}

Get workspace
Copy

Return information about a workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234"
4}

Sample Output

1{
2    "data": {
3        "gid": "12345678901234",
4        "email_domains": [
5            "example.com",
6            "example.org"
7        ],
8        "is_organization": true,
9        "name": "My Awesome Workspace"
10    }
11}

List custom fields
Copy

List all custom fields in a given workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "limit": 50
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "name": "Priority",
6            "resource_subtype": "enum",
7            "resource_type": "custom_field",
8            "type": "enum"
9        },
10        {
11            "gid": "1201234567891",
12            "name": "Due Date",
13            "resource_subtype": "date",
14            "resource_type": "custom_field",
15            "type": "date"
16        },
17        {
18            "gid": "1201234567892",
19            "name": "Estimated Hours",
20            "resource_subtype": "number",
21            "resource_type": "custom_field",
22            "type": "number"
23        }
24    ],
25    "next_page": {
26        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
27        "path": "/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
28        "uri": "https://app.asana.com/api/1.0/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
29    }
30}

List custom fields in portfolio
Copy

Return custom fields in a given portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "portfolio_gid": "98765432109876",
5    "limit": 50,
6    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
7}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "custom_field": {
6                "gid": "1201234567891",
7                "enum_options": [
8                    {
9                        "gid": "1201234567892",
10                        "color": "blue",
11                        "enabled": true,
12                        "name": "Low",
13                        "resource_type": "enum_option"
14                    },
15                    {
16                        "gid": "1201234567893",
17                        "color": "yellow",
18                        "enabled": true,
19                        "name": "Medium",
20                        "resource_type": "enum_option"
21                    },
22                    {
23                        "gid": "1201234567894",
24                        "color": "red",
25                        "enabled": true,
26                        "name": "High",
27                        "resource_type": "enum_option"
28                    }
29                ],
30                "name": "Priority",
31                "resource_subtype": "enum",
32                "resource_type": "custom_field",
33                "type": "enum"
34            },
35            "is_important": true,
36            "parent": {
37                "gid": "1201234567895",
38                "name": "Project Management",
39                "resource_type": "portfolio"
40            },
41            "resource_type": "portfolio_item"
42        }
43    ],
44    "next_page": {
45        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
46        "path": "/portfolios/98765432109876/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
47        "uri": "https://app.asana.com/api/1.0/portfolios/98765432109876/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
48    }
49}

List organization teams
Copy

Get a list of all of the teams in an organization workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "organization_gid": "12345678901234",
4    "limit": 50,
5    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
6}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "name": "Marketing Team"
6        },
7        {
8            "gid": "2345678901",
9            "name": "Development Team"
10        },
11        {
12            "gid": "3456789012",
13            "name": "Sales Team"
14        }
15    ],
16    "next_page": {
17        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
18        "path": "/organizations/12345678901234/teams?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
19        "uri": "https://app.asana.com/api/1.0/organizations/12345678901234/teams?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
20    }
21}

List portfolio projects
Copy

Return a list of all projects in a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "portfolio_gid": "98765432109876",
5    "limit": 50,
6    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
7}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1111111111111",
5            "name": "Project Alpha",
6            "resource_type": "project"
7        },
8        {
9            "gid": "2222222222222",
10            "name": "Project Beta",
11            "resource_type": "project"
12        },
13        {
14            "gid": "3333333333333",
15            "name": "Project Gamma",
16            "resource_type": "project"
17        }
18    ]
19}

List portfolios
Copy

Return a list of all portfolios.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "9876543210987",
5    "limit": 50,
6    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
7}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "name": "Q3 Marketing Campaigns",
6            "resource_type": "portfolio"
7        },
8        {
9            "gid": "1201234567891",
10            "name": "Product Development Roadmap",
11            "resource_type": "portfolio"
12        },
13        {
14            "gid": "1201234567892",
15            "name": "HR Initiatives",
16            "resource_type": "portfolio"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
21        "path": "/portfolios?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
22        "uri": "https://app.asana.com/api/1.0/portfolios?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
23    }
24}

List project custom field settings
Copy

Retrieve a list of all of the custom fields settings on a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876"
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "custom_field": {
6                "gid": "987654321098",
7                "enum_options": [
8                    {
9                        "gid": "1234567890123",
10                        "color": "blue",
11                        "enabled": true,
12                        "name": "Low",
13                        "resource_type": "enum_option"
14                    },
15                    {
16                        "gid": "2345678901234",
17                        "color": "yellow",
18                        "enabled": true,
19                        "name": "Medium",
20                        "resource_type": "enum_option"
21                    },
22                    {
23                        "gid": "3456789012345",
24                        "color": "red",
25                        "enabled": true,
26                        "name": "High",
27                        "resource_type": "enum_option"
28                    }
29                ],
30                "has_notifications_enabled": false,
31                "name": "Priority",
32                "created_by": {
33                    "gid": "5678901234567",
34                    "name": "John Doe",
35                    "resource_type": "user"
36                },
37                "resource_subtype": "enum",
38                "resource_type": "custom_field",
39                "type": "enum",
40                "is_global_to_workspace": false
41            },
42            "is_important": true,
43            "parent": {
44                "gid": "98765432109876",
45                "name": "Project Alpha",
46                "resource_type": "project"
47            },
48            "project": {
49                "gid": "98765432109876",
50                "name": "Project Alpha",
51                "resource_type": "project"
52            },
53            "resource_type": "custom_field_setting"
54        }
55    ]
56}

List project sections
Copy

Get a list of all of the sections in a given project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876",
5    "limit": 50
6}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "created_at": "2023-05-15T10:30:00.000Z",
6            "name": "To Do"
7        },
8        {
9            "gid": "2345678901",
10            "created_at": "2023-05-15T10:31:00.000Z",
11            "name": "In Progress"
12        },
13        {
14            "gid": "3456789012",
15            "created_at": "2023-05-15T10:32:00.000Z",
16            "name": "Review"
17        },
18        {
19            "gid": "4567890123",
20            "created_at": "2023-05-15T10:33:00.000Z",
21            "name": "Done"
22        }
23    ],
24    "next_page": {
25        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
26        "path": "/projects/98765432109876/sections?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
27        "uri": "https://app.asana.com/api/1.0/projects/98765432109876/sections?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
28    }
29}

List project tasks
Copy

Get a list of all the tasks in a project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876",
5    "limit": 50,
6    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
7}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "assignee": "5678901234",
6            "assignee_status": "upcoming",
7            "completed": false,
8            "completed_at": null,
9            "created_at": "2023-05-15T10:30:00.000Z",
10            "custom_fields": [
11                {
12                    "gid": "9876543210",
13                    "enabled": true,
14                    "name": "Priority",
15                    "created_by": {
16                        "gid": "1357924680",
17                        "name": "John Doe",
18                        "resource_type": "user"
19                    },
20                    "display_value": "High",
21                    "resource_subtype": "enum",
22                    "resource_type": "custom_field",
23                    "text_value": "High",
24                    "type": "enum"
25                }
26            ],
27            "due_at": "2023-05-20T17:00:00.000Z",
28            "due_on": "2023-05-20",
29            "followers": [
30                {
31                    "gid": "2468135790",
32                    "resource_type": "user"
33                }
34            ],
35            "hearted": false,
36            "hearts": [],
37            "html_notes": "<body>Complete project documentation</body>",
38            "memberships": [
39                {
40                    "project": {
41                        "gid": "98765432109876",
42                        "resource_type": "project"
43                    },
44                    "section": {
45                        "gid": "3692581470",
46                        "resource_type": "section"
47                    }
48                }
49            ],
50            "modified_at": "2023-05-16T09:45:00.000Z",
51            "name": "Write project documentation",
52            "notes": "Complete project documentation",
53            "num_hearts": 0,
54            "parent": null,
55            "projects": [
56                {
57                    "gid": "98765432109876",
58                    "resource_type": "project"
59                }
60            ],
61            "start_on": "2023-05-17",
62            "tags": [
63                {
64                    "gid": "1472583690",
65                    "name": "Documentation"
66                }
67            ],
68            "workspace": {
69                "gid": "12345678901234",
70                "resource_type": "workspace"
71            }
72        }
73    ],
74    "next_page": {
75        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
76        "path": "/projects/98765432109876/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
77        "uri": "https://app.asana.com/api/1.0/projects/98765432109876/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
78    }
79}

List section tasks
Copy

Return the compact section records for all tasks within the given section.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "section_gid": "34567890123456",
6    "limit": 50,
7    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
8}

Sample Output

1{
2    "data": [
3        {
4            "gid": "45678901234567",
5            "name": "Complete project proposal",
6            "resource_type": "task"
7        },
8        {
9            "gid": "56789012345678",
10            "name": "Review client feedback",
11            "resource_type": "task"
12        },
13        {
14            "gid": "67890123456789",
15            "name": "Schedule team meeting",
16            "resource_type": "task"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
21        "path": "/sections/34567890123456/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
22        "uri": "https://app.asana.com/api/1.0/sections/34567890123456/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
23    }
24}

List task attachments
Copy

Retrieve a list of all attachments on the task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "gid": "1234567890"
4}

Sample Output

1{
2    "data": [
3        {
4            "gid": "9876543210",
5            "name": "project_proposal.pdf",
6            "resource_type": "attachment",
7            "resource_subtype": "file"
8        },
9        {
10            "gid": "5432109876",
11            "name": "meeting_notes.docx",
12            "resource_type": "attachment",
13            "resource_subtype": "file"
14        },
15        {
16            "gid": "1357924680",
17            "name": "budget_spreadsheet.xlsx",
18            "resource_type": "attachment",
19            "resource_subtype": "file"
20        }
21    ]
22}

List task custom fields for project
Copy

Retrieve a list of all tasks custom fields for a single project.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876"
5}

Sample Output

1{
2    "results": [
3        {
4            "gid": "1201234567890",
5            "name": "Priority",
6            "resource_subtype": "enum",
7            "resource_type": "custom_field",
8            "type": "enum"
9        },
10        {
11            "gid": "1201234567891",
12            "name": "Due Date",
13            "resource_subtype": "date",
14            "resource_type": "custom_field",
15            "type": "date"
16        },
17        {
18            "gid": "1201234567892",
19            "name": "Estimated Hours",
20            "resource_subtype": "number",
21            "resource_type": "custom_field",
22            "type": "number"
23        }
24    ]
25}

List task custom fields for projects
Copy

Retrieve a list of all tasks custom fields for multiple projects.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "projects": [
5        "987654321098",
6        "876543210987"
7    ]
8}

Sample Output

1{
2    "custom_fields": [
3        {
4            "gid": "1201234567890",
5            "name": "Priority",
6            "resource_subtype": "enum",
7            "resource_type": "custom_field",
8            "type": "enum"
9        },
10        {
11            "gid": "1301234567891",
12            "name": "Due Date",
13            "resource_subtype": "date",
14            "resource_type": "custom_field",
15            "type": "date"
16        },
17        {
18            "gid": "1401234567892",
19            "name": "Estimated Hours",
20            "resource_subtype": "number",
21            "resource_type": "custom_field",
22            "type": "number"
23        }
24    ]
25}

List task dependencies
Copy

Return a list of all the other tasks that a specified task is dependent on.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "limit": 50,
7    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
8}

Sample Output

1{
2    "data": [
3        {
4            "gid": "12345678901234",
5            "name": "Design mockups",
6            "resource_type": "task"
7        },
8        {
9            "gid": "23456789012345",
10            "name": "Gather requirements",
11            "resource_type": "task"
12        },
13        {
14            "gid": "34567890123456",
15            "name": "Stakeholder approval",
16            "resource_type": "task"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
21        "path": "/tasks/87654321098765/dependencies?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
22        "uri": "https://app.asana.com/api/1.0/tasks/87654321098765/dependencies?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
23    }
24}

List task dependents
Copy

List all the dependents from a task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "limit": 50,
7    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
8}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "name": "Prepare project proposal",
6            "resource_type": "task"
7        },
8        {
9            "gid": "2345678901",
10            "name": "Schedule client meeting",
11            "resource_type": "task"
12        },
13        {
14            "gid": "3456789012",
15            "name": "Review budget estimates",
16            "resource_type": "task"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
21        "path": "/tasks/87654321098765/dependents?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
22        "uri": "https://app.asana.com/api/1.0/tasks/87654321098765/dependents?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
23    }
24}

List task stories
Copy

Get a list of all of the stories on a task, including comments, and other actions.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "limit": 50,
7    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
8}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890123",
5            "created_at": "2023-05-15T14:30:00.000Z",
6            "created_by": {
7                "gid": "98765432109876",
8                "resource_type": "user"
9            },
10            "hearted": false,
11            "html_text": "<body>Added a new subtask: Review design mockups</body>",
12            "num_hearts": 0,
13            "source": "web",
14            "target": {
15                "gid": "87654321098765",
16                "resource_type": "task"
17            },
18            "text": "Added a new subtask: Review design mockups",
19            "type": "system"
20        },
21        {
22            "gid": "1201234567890124",
23            "created_at": "2023-05-16T10:15:00.000Z",
24            "created_by": {
25                "gid": "12345678901234",
26                "resource_type": "user"
27            },
28            "hearted": true,
29            "html_text": "<body>Great progress on this task! Let's schedule a review meeting.</body>",
30            "num_hearts": 2,
31            "source": "web",
32            "target": {
33                "gid": "87654321098765",
34                "resource_type": "task"
35            },
36            "text": "Great progress on this task! Let's schedule a review meeting.",
37            "type": "comment"
38        }
39    ],
40    "next_page": {
41        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
42        "path": "/tasks/87654321098765/stories?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
43        "uri": "https://app.asana.com/api/1.0/tasks/87654321098765/stories?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
44    }
45}

List task subtasks
Copy

Find a task's subtasks.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "56789012345678",
5    "task_gid": "98765432109876",
6    "limit": 50,
7    "offset": "eyJ0eXAiOJiKV1iLCJhbGciOiJIUzI1NiJ9"
8}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "assignee": {
6                "gid": "56789012345678",
7                "resource_type": "user"
8            },
9            "assignee_status": "upcoming",
10            "completed": false,
11            "completed_at": null,
12            "created_at": "2023-05-15T10:30:00.000Z",
13            "custom_fields": [
14                {
15                    "gid": "987654321",
16                    "enabled": true,
17                    "enum_options": [
18                        {
19                            "gid": "123456789",
20                            "color": "blue",
21                            "enabled": true,
22                            "name": "Low",
23                            "resource_type": "enum_option"
24                        }
25                    ],
26                    "enum_value": {
27                        "gid": "123456789",
28                        "color": "blue",
29                        "enabled": true,
30                        "name": "Low",
31                        "resource_type": "enum_option"
32                    },
33                    "name": "Priority",
34                    "created_by": {
35                        "gid": "11223344556677",
36                        "name": "John Doe",
37                        "resource_type": "user"
38                    },
39                    "resource_subtype": "enum",
40                    "resource_type": "custom_field",
41                    "type": "enum"
42                }
43            ],
44            "due_on": "2023-05-20",
45            "followers": [
46                {
47                    "gid": "11223344556677",
48                    "resource_type": "user"
49                }
50            ],
51            "hearted": false,
52            "hearts": [],
53            "html_notes": "<body>Complete the first draft of the report</body>",
54            "modified_at": "2023-05-15T14:45:00.000Z",
55            "name": "Write first draft",
56            "notes": "Complete the first draft of the report",
57            "num_hearts": 0,
58            "parent": {
59                "gid": "98765432109876",
60                "resource_type": "task"
61            },
62            "projects": [
63                {
64                    "gid": "22334455667788",
65                    "resource_type": "project"
66                }
67            ],
68            "tags": [
69                {
70                    "gid": "33445566778899",
71                    "resource_type": "tag"
72                }
73            ],
74            "workspace": {
75                "gid": "12345678901234",
76                "resource_type": "workspace"
77            }
78        }
79    ],
80    "next_page": {
81        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
82        "path": "/tasks/98765432109876/subtasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
83        "uri": "https://app.asana.com/api/1.0/tasks/98765432109876/subtasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
84    }
85}

List tasks
Copy

List tasks by criteria.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "search_by": {
5        "project_gid": "987654321098"
6    },
7    "completed_since": "2023-05-01T00:00:00Z",
8    "modified_since": "2023-05-15T00:00:00Z",
9    "limit": 50,
10    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
11}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "name": "Update project documentation",
6            "resource_type": "task"
7        },
8        {
9            "gid": "1201234567891",
10            "name": "Review client feedback",
11            "resource_type": "task"
12        },
13        {
14            "gid": "1201234567892",
15            "name": "Prepare presentation for stakeholders",
16            "resource_type": "task"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
21        "path": "/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
22        "uri": "https://app.asana.com/api/1.0/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
23    }
24}

List team members
Copy

Get a list of all of the users part of the team.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "organization_gid": "12345678901234",
4    "team_gid": "98765432109876"
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1111111111111",
5            "name": "John Doe",
6            "resource_type": "user"
7        },
8        {
9            "gid": "2222222222222",
10            "name": "Jane Smith",
11            "resource_type": "user"
12        },
13        {
14            "gid": "3333333333333",
15            "name": "Mike Johnson",
16            "resource_type": "user"
17        }
18    ]
19}

List workspace projects
Copy

Retrieve a list of all the projects you can access in your account.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "organization_gid": "98765432109876",
5    "limit": 50,
6    "archived": false,
7    "team_gid": "56789012345678",
8    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
9}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "archived": false,
6            "color": "light-green",
7            "created_at": "2023-05-15T10:30:00.000Z",
8            "current_status": "on_track",
9            "due_date": "2023-06-30",
10            "followers": [
11                {
12                    "gid": "5678901234",
13                    "resource_type": "user"
14                },
15                {
16                    "gid": "6789012345",
17                    "resource_type": "user"
18                }
19            ],
20            "members": [
21                {
22                    "gid": "7890123456",
23                    "resource_type": "user"
24                },
25                {
26                    "gid": "8901234567",
27                    "resource_type": "user"
28                }
29            ],
30            "modified_at": "2023-05-20T14:45:00.000Z",
31            "name": "Q2 Marketing Campaign",
32            "notes": "This project aims to increase brand awareness through social media and content marketing.",
33            "owner": {
34                "gid": "9012345678",
35                "resource_type": "user"
36            },
37            "public": true,
38            "team": {
39                "gid": "56789012345678",
40                "resource_type": "team"
41            },
42            "workspace": {
43                "gid": "12345678901234",
44                "resource_type": "workspace"
45            }
46        }
47    ],
48    "next_page": {
49        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
50        "path": "/projects?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
51        "uri": "https://app.asana.com/api/1.0/projects?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
52    }
53}

List workspace tags
Copy

Retrieve a list of tags from a workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "limit": 50
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "name": "Priority"
6        },
7        {
8            "gid": "1201234567891",
9            "name": "In Progress"
10        },
11        {
12            "gid": "1201234567892",
13            "name": "Blocked"
14        }
15    ],
16    "next_page": {
17        "offset": "eyJ0eXAiOJiKV1iLCJhbGciOiJIUzI1NiJ9",
18        "path": "/workspaces/12345678901234/tags?limit=50&offset=eyJ0eXAiOJiKV1iLCJhbGciOiJIUzI1NiJ9",
19        "uri": "https://app.asana.com/api/1.0/workspaces/12345678901234/tags?limit=50&offset=eyJ0eXAiOJiKV1iLCJhbGciOiJIUzI1NiJ9"
20    }
21}

List workspace tasks
Copy

Retrieve a list of tasks from a workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "me",
5    "limit": 50,
6    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
7}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1201234567890",
5            "name": "Complete project proposal",
6            "resource_type": "task"
7        },
8        {
9            "gid": "1201234567891",
10            "name": "Review client feedback",
11            "resource_type": "task"
12        },
13        {
14            "gid": "1201234567892",
15            "name": "Schedule team meeting",
16            "resource_type": "task"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjE1NjI3NjU0MzB9.7qLN7",
21        "path": "/tasks?limit=50&workspace=12345678901234&assignee=me&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjE1NjI3NjU0MzB9.7qLN7",
22        "uri": "https://app.asana.com/api/1.0/tasks?limit=50&workspace=12345678901234&assignee=me&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjE1NjI3NjU0MzB9.7qLN7"
23    }
24}

List workspace users
Copy

Retrieve a list of all users in a workspace.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "limit": 50
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890",
5            "email": "john.doe@example.com",
6            "name": "John Doe"
7        },
8        {
9            "gid": "2345678901",
10            "email": "jane.smith@example.com",
11            "name": "Jane Smith"
12        },
13        {
14            "gid": "3456789012",
15            "email": "mike.johnson@example.com",
16            "name": "Mike Johnson"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
21        "path": "/workspaces/12345678901234/users?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
22        "uri": "https://app.asana.com/api/1.0/workspaces/12345678901234/users?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
23    }
24}

List workspaces
Copy

Retrieve a list of all the workspaces you can access in your account.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "limit": 50,
4    "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
5}

Sample Output

1{
2    "data": [
3        {
4            "gid": "12345678",
5            "is_organization": true,
6            "name": "Acme Corporation"
7        },
8        {
9            "gid": "87654321",
10            "is_organization": false,
11            "name": "Personal Projects"
12        },
13        {
14            "gid": "56789012",
15            "is_organization": true,
16            "name": "Marketing Team"
17        }
18    ],
19    "next_page": {
20        "offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
21        "path": "/workspaces?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
22        "uri": "https://app.asana.com/api/1.0/workspaces?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
23    }
24}

Project exists?
Copy

Check if a project exists in Asana.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "98765432109876"
5}

Sample Output

1{
2    "result": true
3}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "method": "GET",
4    "url": {
5        "endpoint": "/users/me"
6    },
7    "headers": [
8        {
9            "key": "Accept",
10            "value": "application/json"
11        }
12    ],
13    "query_parameters": [
14        {
15            "key": "opt_fields",
16            "value": "name,email"
17        }
18    ],
19    "body": {
20        "none": null
21    },
22    "include_raw_body": false,
23    "parse_response": "true"
24}

Sample Output

1{
2    "response": {
3        "status_code": 200,
4        "headers": {
5            "Content-Type": "application/json; charset=UTF-8",
6            "X-Asana-Request-Id": "1234567890abcdef"
7        },
8        "body": {
9            "data": {
10                "gid": "1234567890",
11                "name": "John Doe",
12                "email": "john.doe@example.com"
13            }
14        }
15    }
16}

Remove custom field from portfolio
Copy

Remove a custom field from a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "98765432109876",
5    "portfolio_gid": "45678901234567",
6    "custom_field_gid": "78901234567890"
7}

Sample Output

1{
2    "success": true
3}

Remove followers from a task
Copy

Remove each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "followers": [
7        "11111111111111",
8        "22222222222222"
9    ]
10}

Sample Output

1{
2    "success": true
3}

Remove members from portfolio
Copy

Remove members from a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "98765432109876",
5    "portfolio_gid": "45678901234567",
6    "members": [
7        "23456789012345",
8        "34567890123456"
9    ]
10}

Sample Output

1{
2    "success": true
3}

Remove project from portfolio
Copy

Remove a project from a portfolio.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "owner_gid": "98765432109876",
5    "portfolio_gid": "45678901234567",
6    "project_gid": "78901234567890"
7}

Sample Output

1{
2    "success": true
3}

Remove tag from task
Copy

Remove a tag from a particular task.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "1234567890",
5    "task_gid": "9876543210",
6    "tag_gid": "5678901234"
7}

Sample Output

1{
2    "success": true
3}

Remove task from project
Copy

Remove the task from the specified project. The task will still exist in the system, but it will not be in the project anymore.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "task_gid": "34567890123456",
6    "assignee_gid": "45678901234567"
7}

Sample Output

1{
2    "data": {
3        "gid": "34567890123456",
4        "assignee": {
5            "gid": "45678901234567",
6            "resource_type": "user"
7        },
8        "assignee_status": "upcoming",
9        "completed": false,
10        "completed_at": null,
11        "created_at": "2023-05-15T10:30:00.000Z",
12        "due_at": null,
13        "due_on": "2023-05-30",
14        "followers": [
15            {
16                "gid": "56789012345678",
17                "resource_type": "user"
18            }
19        ],
20        "hearted": false,
21        "hearts": [],
22        "html_notes": "<body>Task description with <b>formatted</b> text.</body>",
23        "memberships": [],
24        "modified_at": "2023-05-15T14:45:00.000Z",
25        "name": "Complete project documentation",
26        "notes": "Task description with formatted text.",
27        "num_hearts": 0,
28        "parent": null,
29        "projects": [],
30        "start_on": "2023-05-16",
31        "tags": [
32            {
33                "gid": "67890123456789",
34                "name": "Documentation"
35            }
36        ],
37        "workspace": {
38            "gid": "12345678901234",
39            "resource_type": "workspace"
40        }
41    }
42}

Search tasks
Copy

Search tasks in a workspace, this endpoint will only be available to premium Asana users.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "gid": "12345678901234567",
4    "search_parameters": [
5        {
6            "name": "text",
7            "value": "Project update"
8        },
9        {
10            "name": "due_on.before",
11            "value": "2023-12-31"
12        },
13        {
14            "name": "assignee.any",
15            "value": "1234567890,2345678901"
16        }
17    ],
18    "custom_fields": [
19        {
20            "gid": "9876543210987654",
21            "comparator": "value",
22            "value": "High"
23        }
24    ],
25    "sort_by": "due_date",
26    "sort_ascending": true,
27    "opt_pretty": true,
28    "opt_fields": [
29        "name",
30        "due_on",
31        "assignee"
32    ]
33}

Sample Output

1{
2    "data": [
3        {
4            "gid": "1234567890123456",
5            "name": "Prepare project update presentation",
6            "resource_type": "task",
7            "due_on": "2023-12-15",
8            "assignee": {
9                "gid": "1234567890",
10                "name": "John Doe"
11            }
12        },
13        {
14            "gid": "2345678901234567",
15            "name": "Review project metrics for update",
16            "resource_type": "task",
17            "due_on": "2023-12-20",
18            "assignee": {
19                "gid": "2345678901",
20                "name": "Jane Smith"
21            }
22        }
23    ]
24}

Set dependencies for a task
Copy

Mark a set of tasks as dependencies of this task, if they are not already dependencies. A task can have at most 15 dependencies.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "dependencies": [
7        "76543210987654",
8        "65432109876543",
9        "54321098765432"
10    ]
11}

Sample Output

1{
2    "success": true
3}

Set dependents for a task
Copy

Mark a set of tasks as dependents of this task, if they are not already dependents. A task can have at most 30 dependents.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "1234567890123456",
6    "dependents": [
7        "2345678901234567",
8        "3456789012345678",
9        "4567890123456789"
10    ]
11}

Sample Output

1{
2    "success": true
3}

Unlink dependencies from a task
Copy

Unlink a set of dependencies from this task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "1122334455667788",
6    "dependencies": [
7        "2233445566778899",
8        "3344556677889900"
9    ]
10}

Sample Output

1{
2    "success": true
3}

Unlink dependents from a task
Copy

Unlink a set of dependents from this task.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "assignee_gid": "98765432109876",
5    "task_gid": "87654321098765",
6    "dependents": [
7        "76543210987654",
8        "65432109876543"
9    ]
10}

Sample Output

1{
2    "success": true
3}

Update custom field
Copy

Update a custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "98765432109876",
5    "name": "Priority Level",
6    "description": "Indicates the priority level of the task",
7    "custom_field_resource_subtype": {
8        "number": {
9            "precision": 0
10        }
11    }
12}

Sample Output

1{
2    "data": {
3        "gid": "98765432109876",
4        "resource_type": "custom_field",
5        "resource_subtype": "number",
6        "type": "number",
7        "name": "Priority Level",
8        "description": "Indicates the priority level of the task",
9        "is_global_to_workspace": true,
10        "precision": 0,
11        "created_by": {
12            "gid": "1234567890",
13            "resource_type": "user",
14            "name": "John Doe"
15        }
16    }
17}

Update drop down option in custom field
Copy

Update a drop-down option attached to a custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnop",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "987654321098765",
5    "option_gid": "456789012345678",
6    "name": "Updated Option Name",
7    "color": "light-green",
8    "enabled": true
9}

Sample Output

1{
2    "data": {
3        "gid": "456789012345678",
4        "resource_type": "enum_option",
5        "enabled": true,
6        "name": "Updated Option Name",
7        "color": "light-green"
8    }
9}

Update order of drop down options in custom field
Copy

Reorder the drop-down options in a given custom field.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "custom_field_gid": "98765432109876",
5    "option_gid": "56789012345678",
6    "option_position": {
7        "insert_before": "45678901234567"
8    }
9}

Sample Output

1{
2    "success": true
3}

Update section
Copy

Update a section.

Sample Input

1{
2    "access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
3    "workspace_gid": "12345678901234",
4    "project_gid": "23456789012345",
5    "section_gid": "34567890123456",
6    "name": "Updated Section Name"
7}

Sample Output

1{
2    "data": {
3        "gid": "34567890123456",
4        "resource_type": "section",
5        "created_at": "2023-05-15T14:30:00.000Z",
6        "name": "Updated Section Name",
7        "project": {
8            "gid": "23456789012345",
9            "resource_type": "project",
10            "name": "Project Alpha"
11        }
12    }
13}

Update task
Copy

Update a task.

Sample Input

1{
2    "access_token": "0/a1b2c3d4e5f6g7h8i9j0",
3    "workspace_gid": "1234567890",
4    "task_gid": "9876543210",
5    "name": "Update project proposal",
6    "notes": "Incorporate feedback from last meeting",
7    "assignee_gid": "1122334455",
8    "due_on": "2023-06-30",
9    "completed": false,
10    "custom_fields": [
11        {
12            "custom_field_gid": "12345",
13            "value": "High"
14        }
15    ],
16    "liked": true,
17    "dependencies": [
18        "5566778899",
19        "1122334455"
20    ]
21}

Sample Output

1{
2    "data": {
3        "gid": "9876543210",
4        "resource_type": "task",
5        "created_at": "2023-05-15T09:00:00.000Z",
6        "modified_at": "2023-05-20T14:30:00.000Z",
7        "name": "Update project proposal",
8        "notes": "Incorporate feedback from last meeting",
9        "assignee": {
10            "gid": "1122334455",
11            "resource_type": "user",
12            "name": "John Doe"
13        },
14        "completed": false,
15        "assignee_status": "upcoming",
16        "completed_at": null,
17        "due_on": "2023-06-30",
18        "due_at": null,
19        "resource_subtype": "default_task",
20        "workspace": {
21            "gid": "1234567890",
22            "resource_type": "workspace",
23            "name": "My Workspace"
24        },
25        "num_hearts": 2,
26        "num_likes": 3,
27        "permalink_url": "https://app.asana.com/0/1234567890/9876543210",
28        "liked": true,
29        "custom_fields": [
30            {
31                "gid": "12345",
32                "resource_type": "custom_field",
33                "name": "Priority",
34                "type": "enum",
35                "text_value": "High"
36            }
37        ],
38        "dependencies": [
39            {
40                "gid": "5566778899",
41                "resource_type": "task"
42            },
43            {
44                "gid": "1122334455",
45                "resource_type": "task"
46            }
47        ]
48    }
49}