Operations (sample payloads)
Main operations
Add custom field to portfolio
Add a custom field to a portfolio. Sample Input Sample Output
{
"data": {
"gid": "89012345678901",
"resource_type": "portfolio_custom_field_setting",
"custom_field": {
"gid": "78901234567890",
"resource_type": "custom_field",
"created_by": \{
"gid": "23456789012345",
"resource_type": "user",
"name": "John Doe"
\},
"resource_subtype": "enum",
"type": "enum",
"name": "Project Status",
"enum_options": [
\{
"gid": "34567890123456",
"resource_type": "enum_option",
"enabled": true,
"name": "Not Started",
"color": "red"
\},
\{
"gid": "45678901234567",
"resource_type": "enum_option",
"enabled": true,
"name": "In Progress",
"color": "yellow"
\},
\{
"gid": "56789012345678",
"resource_type": "enum_option",
"enabled": true,
"name": "Completed",
"color": "green"
\}
]
},
"is_important": true,
"parent": \{
"gid": "45678901234567",
"resource_type": "portfolio",
"name": "Q3 Projects"
\}
}
}
Add custom field to project
Add a custom field to a project. Sample Input Sample Output
Add drop down option to custom field
Add an enum option to a custom field. Sample Input Sample Output
Add followers to a task
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 Sample Output
Add members to portfolio
Add members to a portfolio. Sample Input Sample Output
Add project status update
Add a status update to a project, setting a "message" and a colour reflecting the project's status. Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnop",
"workspace_gid": "12345678901234",
"project_gid": "98765432109876",
"current_status": \{
"color": "yellow",
"text": "Project is progressing, but we're facing some minor delays."
\}
}
Sample Output
Add project to portfolio
Add a project to a portfolio. Sample Input Sample Output
Add tag to task
Add a tag to a particular task. Sample Input Sample Output
Add task dependencies
Add dependencies to a task. Sample Input Sample Output
Add task to project
Add a task to a project. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnop",
"workspace_gid": "12345678901234",
"project_gid": "23456789012345",
"task_gid": "34567890123456",
"section_gid": "45678901234567",
"assignee_gid": "56789012345678"
\}
Sample Output
Add task to section
Add a task to a section. Sample Input Sample Output
{
"success": true
}
Copy all project custom fields
Copy all custom fields from a source project to a destination project. This is operation is only available to premium Asana accounts. Sample Input Sample Output
Copy all tasks
Copy all tasks from one project to another, including those that are marked completed and archived in the source. Sample Input Sample Output
Copy task
Copy a task, copying over the description, followers, and assignee, along with subtasks and custom field settings. Sample Input Sample Output
Create custom field
Create a new custom field. Sample Input
{
"access_token": "0/a1b2c3d4e5f6g7h8i9j0",
"workspace_gid": "12345678901234",
"name": "Priority",
"description": "Indicates the priority level of the task",
"custom_field_resource_subtype": {
"drop_down": {
"options": [
\{
"name": "Low",
"color": "light-green"
\},
\{
"name": "Medium",
"color": "yellow"
\},
\{
"name": "High",
"color": "red"
\}
]
}
}
}
Sample Output
Create membership
Create a new membership in a goal or project. Sample Input Sample Output
{
"data": {
"gid": "1122334455",
"resource_subtype": "membership",
"resource_type": "membership",
"access_level": "editor",
"parent": \{
"gid": "1234567890",
"resource_type": "project",
"name": "Q4 Marketing Campaign"
\},
"member": \{
"gid": "9876543210",
"resource_type": "user",
"name": "John Doe"
\}
}
}
Create portfolio
Create a new portfolio. Sample Input Sample Output
{
"data": {
"gid": "1201234567890123",
"resource_type": "portfolio",
"created_at": "2023-06-15T14:30:00.000Z",
"name": "Q4 2023 Projects",
"workspace": \{
"gid": "12345678901234",
"resource_type": "workspace",
"name": "My Company Workspace"
\},
"permalink_url": "https://app.asana.com/0/portfolio/1201234567890123",
"color": "light-green",
"due_on": null,
"start_on": null,
"created_by": \{
"gid": "1234567890",
"resource_type": "user",
"name": "John Doe"
\},
"members": [
\{
"gid": "1234567890",
"resource_type": "user",
"name": "John Doe"
\}
],
"custom_field_settings": [],
"owner": \{
"gid": "1234567890",
"resource_type": "user",
"name": "John Doe"
\}
}
}
Create project
Create a project. Sample Input Sample Output
{
"data": {
"gid": "1201234567890123",
"resource_type": "project",
"created_at": "2023-09-15T14:30:00.000Z",
"modified_at": "2023-09-15T14:30:00.000Z",
"owner": \{
"gid": "78901234567890",
"resource_type": "user",
"name": "John Doe"
\},
"due_date": null,
"due_on": "2023-12-31",
"public": false,
"privacy_setting": "private_to_team",
"name": "Q4 Marketing Campaign",
"notes": "This project covers all marketing activities for Q4, including social media campaigns, email marketing, and content creation.",
"archived": false,
"workspace": \{
"gid": "12345678901234",
"resource_type": "workspace",
"name": "Marketing Team Workspace"
\},
"team": \{
"gid": "45678901234567",
"resource_type": "team",
"name": "Marketing Team"
\},
"permalink_url": "https://app.asana.com/0/1201234567890123/1201234567890123",
"is_template": false,
"default_view": "board",
"start_on": "2023-10-01",
"color": "light-green",
"icon": "clipboard",
"current_status": {
"gid": "1301234567890123",
"title": "On track",
"color": "green",
"text": "On track",
"created_at": "2023-09-15T14:30:00.000Z",
"modified_at": "2023-09-15T14:30:00.000Z",
"created_by": \{
"gid": "78901234567890",
"resource_type": "user",
"name": "John Doe"
\},
"author": \{
"gid": "78901234567890",
"resource_type": "user",
"name": "John Doe"
\}
},
"custom_field_settings": [],
"custom_fields": [],
"members": [
\{
"gid": "78901234567890",
"resource_type": "user",
"name": "John Doe"
\}
],
"followers": [
\{
"gid": "78901234567890",
"resource_type": "user",
"name": "John Doe"
\}
]
}
}
Create project section
Create a project section. Sample Input Sample Output
Create subtask
Create a subtask. Sample Input Sample Output
Create tag
Create a new tag in a workspace. Sample Input Sample Output
Create task
Create a new task. Sample Input
{
"access_token": "0/a1b2c3d4e5f6g7h8i9j0",
"workspace_gid": "12345678901234",
"name": "Prepare quarterly report",
"assignee_gid": "98765432109876",
"task_resource_subtype": "default_task",
"notes": "Compile financial data and create presentation for Q2 results",
"projects": [
"23456789012345",
"34567890123456"
],
"tags": [
"56789012345678",
"67890123456789"
],
"assignee_status": "upcoming",
"due_on": "2023-07-15",
"start_on": "2023-07-01",
"followers": [
"45678901234567",
"56789012345678"
],
"completed": false,
"custom_fields": [
\{
"custom_field_gid": "78901234567890",
"value": "High"
\}
],
"memberships": [
\{
"project": "23456789012345",
"section": "89012345678901"
\}
],
"liked": true
}
Sample Output
{
"data": {
"gid": "1234567890123456",
"resource_type": "task",
"created_at": "2023-06-15T10:30:00.000Z",
"modified_at": "2023-06-15T10:30:00.000Z",
"name": "Prepare quarterly report",
"notes": "Compile financial data and create presentation for Q2 results",
"completed": false,
"assignee_status": "upcoming",
"completed_at": null,
"due_on": "2023-07-15",
"start_on": "2023-07-01",
"resource_subtype": "default_task",
"tags": [
\{
"gid": "56789012345678",
"resource_type": "tag",
"name": "Finance"
\},
\{
"gid": "67890123456789",
"resource_type": "tag",
"name": "Quarterly"
\}
],
"workspace": \{
"gid": "12345678901234",
"resource_type": "workspace",
"name": "My Company"
\},
"num_hearts": 0,
"num_likes": 1,
"permalink_url": "https://app.asana.com/0/12345678901234/1234567890123456",
"assignee": \{
"gid": "98765432109876",
"resource_type": "user",
"name": "John Doe"
\},
"hearted": false,
"hearts": [],
"followers": [
\{
"gid": "45678901234567",
"resource_type": "user",
"name": "Jane Smith"
\},
\{
"gid": "56789012345678",
"resource_type": "user",
"name": "Mike Johnson"
\}
],
"liked": true,
"likes": [
{
"gid": "2345678901234567",
"user": \{
"gid": "98765432109876",
"resource_type": "user",
"name": "John Doe"
\}
}
],
"memberships": [
{
"project": \{
"gid": "23456789012345",
"resource_type": "project",
"name": "Q2 Reporting"
\},
"section": \{
"gid": "89012345678901",
"resource_type": "section",
"name": "In Progress"
\}
},
{
"project": \{
"gid": "34567890123456",
"resource_type": "project",
"name": "Finance Department"
\}
}
],
"custom_fields": [
{
"gid": "78901234567890",
"resource_type": "custom_field",
"created_by": \{
"gid": "34567890123456",
"resource_type": "user",
"name": "Admin User"
\},
"resource_subtype": "enum",
"type": "enum",
"name": "Priority",
"enabled": true,
"text_value": "High"
}
],
"projects": [
\{
"gid": "23456789012345",
"resource_type": "project",
"name": "Q2 Reporting"
\},
\{
"gid": "34567890123456",
"resource_type": "project",
"name": "Finance Department"
\}
]
}
}
Create task comment
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 Sample Output
Delete custom field
Delete a custom field. Sample Input Sample Output
Delete membership
Delete a membership for a goal or project. Sample Input Sample Output
Delete portfolio
Delete a portfolio. Sample Input Sample Output
\{
"existed": true,
"deleted": true
\}
Delete project
Delete a project. Sample Input Sample Output
Delete section
Delete a section. Sample Input Sample Output
\{
"existed": true,
"deleted": true
\}
Delete task
Delete a task. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"assignee_gid": "98765432109876",
"task_gid": "1234567890123456"
\}
Sample Output
Download attachments
Download task attachments hosted on Asana. Maximum total size of attachments is 500MB. Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"attachment_gids": [
{
"gid": "1201234567890123"
},
{
"gid": "1201234567890124"
}
]
}
Sample Output
Get attachment
Get the full record for a single attachment. Sample Input Sample Output
{
"data": {
"gid": "1234567890123456",
"created_at": "2023-05-15T14:30:00.000Z",
"download_url": "https://app.asana.com/app/attachments/1234567890123456/download",
"host": "asana",
"name": "project_report.pdf",
"parent": \{
"gid": "9876543210987654",
"name": "Q2 Project Updates",
"resource_type": "task"
\},
"permanent_url": "https://app.asana.com/0/0/1234567890123456",
"resource_type": "attachment",
"resource_subtype": "pdf",
"view_url": "https://app.asana.com/app/attachments/1234567890123456/view"
}
}
Get custom field
Return all metadata for a specified custom field. Sample Input Sample Output
{
"data": {
"gid": "9876543210987",
"enum_options": [
\{
"gid": "1234567890123",
"color": "blue",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
\},
\{
"gid": "2345678901234",
"color": "yellow",
"enabled": true,
"name": "Medium",
"resource_type": "enum_option"
\},
\{
"gid": "3456789012345",
"color": "red",
"enabled": true,
"name": "High",
"resource_type": "enum_option"
\}
],
"has_notifications_enabled": false,
"name": "Priority",
"created_by": "5678901234567",
"resource_subtype": "enum",
"resource_type": "custom_field",
"type": "enum",
"is_global_to_workspace": true
}
}
Get portfolio
Return data for a specified portfolio. Sample Input Sample Output
Get project
Find a project in an Asana workspace. Sample Input Sample Output
{
"data": {
"gid": "1234567890123456",
"archived": false,
"color": "light-green",
"created_at": "2023-05-15T10:30:00.000Z",
"current_status": {
"gid": "9876543210987654",
"author": \{
"gid": "5678901234567890",
"name": "John Doe",
"resource_type": "user"
\},
"color": "green",
"created_at": "2023-05-20T14:45:00.000Z",
"created_by": \{
"gid": "5678901234567890",
"name": "John Doe",
"resource_type": "user"
\},
"modified_at": "2023-05-20T14:45:00.000Z",
"resource_type": "project_status",
"text": "Project is on track",
"title": "On Track"
},
"custom_fields": [
{
"gid": "1357924680123456",
"enabled": true,
"name": "Priority",
"created_by": \{
"gid": "2468013579246801",
"name": "Jane Smith",
"resource_type": "user"
\},
"display_value": "High",
"resource_subtype": "enum",
"resource_type": "custom_field",
"text_value": "High",
"type": "enum"
}
],
"default_view": "list",
"due_on": "2023-06-30",
"due_date": "2023-06-30",
"followers": [
\{
"gid": "5678901234567890",
"name": "John Doe",
"resource_type": "user"
\},
\{
"gid": "2468013579246801",
"name": "Jane Smith",
"resource_type": "user"
\}
],
"is_template": false,
"members": [
\{
"gid": "5678901234567890",
"name": "John Doe",
"resource_type": "user"
\},
\{
"gid": "2468013579246801",
"name": "Jane Smith",
"resource_type": "user"
\}
],
"modified_at": "2023-05-22T09:15:00.000Z",
"name": "Q2 Marketing Campaign",
"notes": "This project aims to increase brand awareness and generate leads through various marketing channels.",
"owner": \{
"gid": "5678901234567890",
"name": "John Doe",
"resource_type": "user"
\},
"permalink_url": "https://app.asana.com/0/1234567890123456/1234567890123456",
"public": false,
"resource_type": "project",
"start_on": "2023-04-01",
"team": \{
"gid": "3692581470123456",
"name": "Marketing Team",
"resource_type": "team"
\},
"workspace": \{
"gid": "12345678901234",
"name": "My Company",
"resource_type": "workspace"
\}
}
}
Get section
Get a section from your Asana account. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"project_gid": "23456789012345",
"section_gid": "34567890123456"
\}
Sample Output
Get task
Find a task by its GID. Sample Input Sample Output
Get team
Return information about a team. Sample Input Sample Output
{
"data": {
"gid": "9876543210",
"description": "This team is responsible for product development and innovation.",
"name": "Product Development Team",
"organization": \{
"gid": "1234567890",
"resource_type": "organization"
\}
}
}
Get user
Return information about a user. Sample Input
\{
"access_token": "0/a1b2c3d4e5f6g7h8i9j0",
"workspace_gid": "12345678901234",
"user_gid": "9876543210987"
\}
Sample Output
Get user by email
Return information about a user. Sample Input Sample Output
Get workspace
Return information about a workspace. Sample Input Sample Output
List custom fields
List all custom fields in a given workspace. Sample Input Sample Output
List custom fields in portfolio
Return custom fields in a given portfolio. Sample Input Sample Output
{
"data": [
{
"gid": "1201234567890",
"custom_field": {
"gid": "1201234567891",
"enum_options": [
\{
"gid": "1201234567892",
"color": "blue",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
\},
\{
"gid": "1201234567893",
"color": "yellow",
"enabled": true,
"name": "Medium",
"resource_type": "enum_option"
\},
\{
"gid": "1201234567894",
"color": "red",
"enabled": true,
"name": "High",
"resource_type": "enum_option"
\}
],
"name": "Priority",
"resource_subtype": "enum",
"resource_type": "custom_field",
"type": "enum"
},
"is_important": true,
"parent": \{
"gid": "1201234567895",
"name": "Project Management",
"resource_type": "portfolio"
\},
"resource_type": "portfolio_item"
}
],
"next_page": \{
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
"path": "/portfolios/98765432109876/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9",
"uri": "https://app.asana.com/api/1.0/portfolios/98765432109876/custom_fields?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjdXJzb3IiOjF9"
\}
}
List organization teams
Get a list of all of the teams in an organization workspace. Sample Input Sample Output
{
"data": [
\{
"gid": "1234567890",
"name": "Marketing Team"
\},
\{
"gid": "2345678901",
"name": "Development Team"
\},
\{
"gid": "3456789012",
"name": "Sales Team"
\}
],
"next_page": \{
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
"path": "/organizations/12345678901234/teams?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
"uri": "https://app.asana.com/api/1.0/organizations/12345678901234/teams?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
\}
}
List portfolio projects
Return a list of all projects in a portfolio. Sample Input Sample Output
List portfolios
Return a list of all portfolios. Sample Input Sample Output
List project custom field settings
Retrieve a list of all of the custom fields settings on a project. Sample Input Sample Output
List project sections
Get a list of all of the sections in a given project. Sample Input Sample Output
List project tasks
Get a list of all the tasks in a project. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"project_gid": "98765432109876",
"limit": 50,
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
\}
Sample Output
List section tasks
Return the compact section records for all tasks within the given section. Sample Input Sample Output
List task attachments
Retrieve a list of all attachments on the task. Sample Input Sample Output
List task custom fields for project
Retrieve a list of all tasks custom fields for a single project. Sample Input Sample Output
List task custom fields for projects
Retrieve a list of all tasks custom fields for multiple projects. Sample Input Sample Output
List task dependencies
Return a list of all the other tasks that a specified task is dependent on. Sample Input Sample Output
List task dependents
List all the dependents from a task. Sample Input Sample Output
List task stories
Get a list of all of the stories on a task, including comments, and other actions. Sample Input Sample Output
List task subtasks
Find a task's subtasks. Sample Input Sample Output
{
"data": [
{
"gid": "1234567890",
"assignee": \{
"gid": "56789012345678",
"resource_type": "user"
\},
"assignee_status": "upcoming",
"completed": false,
"completed_at": null,
"created_at": "2023-05-15T10:30:00.000Z",
"custom_fields": [
{
"gid": "987654321",
"enabled": true,
"enum_options": [
\{
"gid": "123456789",
"color": "blue",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
\}
],
"enum_value": \{
"gid": "123456789",
"color": "blue",
"enabled": true,
"name": "Low",
"resource_type": "enum_option"
\},
"name": "Priority",
"created_by": \{
"gid": "11223344556677",
"name": "John Doe",
"resource_type": "user"
\},
"resource_subtype": "enum",
"resource_type": "custom_field",
"type": "enum"
}
],
"due_on": "2023-05-20",
"followers": [
\{
"gid": "11223344556677",
"resource_type": "user"
\}
],
"hearted": false,
"hearts": [],
"html_notes": "<body>Complete the first draft of the report</body>",
"modified_at": "2023-05-15T14:45:00.000Z",
"name": "Write first draft",
"notes": "Complete the first draft of the report",
"num_hearts": 0,
"parent": \{
"gid": "98765432109876",
"resource_type": "task"
\},
"projects": [
\{
"gid": "22334455667788",
"resource_type": "project"
\}
],
"tags": [
\{
"gid": "33445566778899",
"resource_type": "tag"
\}
],
"workspace": \{
"gid": "12345678901234",
"resource_type": "workspace"
\}
}
],
"next_page": \{
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
"path": "/tasks/98765432109876/subtasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
"uri": "https://app.asana.com/api/1.0/tasks/98765432109876/subtasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
\}
}
List tasks
List tasks by criteria. Sample Input Sample Output
{
"data": [
\{
"gid": "1201234567890",
"name": "Update project documentation",
"resource_type": "task"
\},
\{
"gid": "1201234567891",
"name": "Review client feedback",
"resource_type": "task"
\},
\{
"gid": "1201234567892",
"name": "Prepare presentation for stakeholders",
"resource_type": "task"
\}
],
"next_page": \{
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
"path": "/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ",
"uri": "https://app.asana.com/api/1.0/tasks?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJvZmZzZXQiOjUwfQ"
\}
}
List team members
Get a list of all of the users part of the team. Sample Input Sample Output
List workspace projects
Retrieve a list of all the projects you can access in your account. Sample Input Sample Output
List workspace tags
Retrieve a list of tags from a workspace. Sample Input Sample Output
List workspace tasks
Retrieve a list of tasks from a workspace. Sample Input Sample Output
List workspace users
Retrieve a list of all users in a workspace. Sample Input Sample Output
{
"data": [
\{
"gid": "1234567890",
"email": "john.doe@example.com",
"name": "John Doe"
\},
\{
"gid": "2345678901",
"email": "jane.smith@example.com",
"name": "Jane Smith"
\},
\{
"gid": "3456789012",
"email": "mike.johnson@example.com",
"name": "Mike Johnson"
\}
],
"next_page": \{
"offset": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
"path": "/workspaces/12345678901234/users?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
"uri": "https://app.asana.com/api/1.0/workspaces/12345678901234/users?limit=50&offset=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
\}
}
List workspaces
Retrieve a list of all the workspaces you can access in your account. Sample Input Sample Output
Project exists?
Check if a project exists in Asana. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"project_gid": "98765432109876"
\}
Sample Output
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input Sample Output
Remove custom field from portfolio
Remove a custom field from a portfolio. Sample Input Sample Output
Remove followers from a task
Remove each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task. Sample Input Sample Output
Remove members from portfolio
Remove members from a portfolio. Sample Input Sample Output
Remove project from portfolio
Remove a project from a portfolio. Sample Input Sample Output
{
"success": true
}
Remove tag from task
Remove a tag from a particular task. Sample Input Sample Output
{
"success": true
}
Remove task from project
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 Sample Output
Search tasks
Search tasks in a workspace, this endpoint will only be available to premium Asana users. Sample Input Sample Output
Set dependencies for a task
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 Sample Output
Set dependents for a task
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 Sample Output
Unlink dependencies from a task
Unlink a set of dependencies from this task. Sample Input Sample Output
Unlink dependents from a task
Unlink a set of dependents from this task. Sample Input
\{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"assignee_gid": "98765432109876",
"task_gid": "87654321098765",
"dependents": [
"76543210987654",
"65432109876543"
]
\}
Sample Output
Update custom field
Update a custom field. Sample Input Sample Output
Update drop down option in custom field
Update a drop-down option attached to a custom field. Sample Input Sample Output
Update order of drop down options in custom field
Reorder the drop-down options in a given custom field. Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz",
"workspace_gid": "12345678901234",
"custom_field_gid": "98765432109876",
"option_gid": "56789012345678",
"option_position": {
"insert_before": "45678901234567"
}
}
Sample Output
{
"success": true
}
Update section
Update a section. Sample Input Sample Output
{
"data": {
"gid": "34567890123456",
"resource_type": "section",
"created_at": "2023-05-15T14:30:00.000Z",
"name": "Updated Section Name",
"project": \{
"gid": "23456789012345",
"resource_type": "project",
"name": "Project Alpha"
\}
}
}
Update task
Update a task. Sample Input Sample Output
DDL operations
List colors (DDL)
Sample Input Sample Output
List custom field drop down options (DDL)
Sample Input Sample Output
List custom fields (DDL)
Sample Input Sample Output
List custom fields in portfolio (DDL)
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
[
\{
"gid": "12345",
"name": "Priority",
"type": "enum"
\},
\{
"gid": "67890",
"name": "Due Date",
"type": "date"
\},
\{
"gid": "13579",
"name": "Status",
"type": "enum"
\},
\{
"gid": "24680",
"name": "Estimated Hours",
"type": "number"
\}
]
List organization teams (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
List organizations (DDL)
Sample Input Sample Output
List portfolio colors (DDL)
Sample Input Sample Output
List portfolio members (DDL)
Sample Input Sample Output
List portfolio projects (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
List portfolios (DDL)
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
List project custom field settings (DDL)
Sample Input
{
"access_token": "1/123456789abcdef"
}
Sample Output
List project custom fields (DDL)
Sample Input Sample Output
[
{
"gid": "1234567890",
"name": "Priority",
"type": "enum",
"enum_options": [
\{
"gid": "1111111111",
"name": "Low",
"color": "blue"
\},
\{
"gid": "2222222222",
"name": "Medium",
"color": "yellow"
\},
\{
"gid": "3333333333",
"name": "High",
"color": "red"
\}
]
},
\{
"gid": "9876543210",
"name": "Due Date",
"type": "date"
\},
\{
"gid": "5555555555",
"name": "Estimated Hours",
"type": "number"
\}
]
List project sections (DDL)
Sample Input Sample Output
{
"data": [
{
"gid": "1201234567890",
"name": "To Do",
"project": \{
"gid": "1201234567891",
"name": "Project Alpha"
\},
"created_at": "2023-05-15T09:00:00.000Z",
"resource_type": "section"
},
{
"gid": "1201234567892",
"name": "In Progress",
"project": \{
"gid": "1201234567891",
"name": "Project Alpha"
\},
"created_at": "2023-05-15T09:01:00.000Z",
"resource_type": "section"
},
{
"gid": "1201234567893",
"name": "Done",
"project": \{
"gid": "1201234567891",
"name": "Project Alpha"
\},
"created_at": "2023-05-15T09:02:00.000Z",
"resource_type": "section"
}
]
}
List project tasks (DDL)
Sample Input Sample Output
List section tasks (DDL)
Sample Input Sample Output
List task custom fields (DDL)
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
List task custom fields from projects (DDL)
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
List task custom fields from task ID (DDL)
Sample Input
{
"access_token": "1/123456789abcdef"
}
Sample Output
List workspace projects (DDL)
Sample Input
{
"access_token": "1/1234567890:abcdefghijklmnopqrstuvwxyz"
}
Sample Output
List workspace projects without team (DDL)
Sample Input Sample Output
List workspace tags (DDL)
Sample Input Sample Output
List workspace tasks (DDL)
Sample Input Sample Output
List workspace users (DDL)
Sample Input Sample Output
{
"workspaces": [
{
"gid": "12345678901234",
"name": "My Workspace",
"users": [
\{
"gid": "1111111111111",
"name": "John Doe",
"email": "john.doe@example.com"
\},
\{
"gid": "2222222222222",
"name": "Jane Smith",
"email": "jane.smith@example.com"
\},
\{
"gid": "3333333333333",
"name": "Bob Johnson",
"email": "bob.johnson@example.com"
\}
]
},
{
"gid": "98765432109876",
"name": "Project X Workspace",
"users": [
\{
"gid": "4444444444444",
"name": "Alice Brown",
"email": "alice.brown@example.com"
\},
\{
"gid": "5555555555555",
"name": "Charlie Davis",
"email": "charlie.davis@example.com"
\}
]
}
]
}
List workspaces (DDL)
Sample Input Sample Output