Asana

App Vendor: Asana

App Category: IT Services

Connector Version: 1.1.0

API Version: 1.0.0

About App

Asana is a web and mobile based project management platform. Asana helps teams organize, track, and manage their work. Forrester, Inc. reports that "Asana simplifies team-based work management".

Asana app is configured with Orchestrate to perform the following actions:

Action Name	Description
Get multiple projects	This action returns a list of projects based on the input parameters.
Create a project	This action creates a new project in a workspace or a team.
Update a project	This action updates the specified fields of a project and returns the updated project record.
Get a project	This action retrieves the record of a project.
Duplicate a project	This action creates and returns an asynchronous job that duplicates a project.
Get projects a task is in	This action returns a list of projects associated with a task.
Get a teams projects	This action returns a list of projects associated with a team.
Create a project in a team	This action creates a project in a team.
Get all projects in a workspace	This action returns a list of projects in a workspace.
Add a custom field to a project	This action adds a custom field to a project.
Remove a custom field from a project	This action removes a custom field from a project.
Add users to a project	This action adds users to a project.
Remove users from a project	This action removes the specified list of users from members of a project and returns the updated list of users in a project.
Add followers to a project	This action adds the specified list of users as followers to the project.
Remove followers from a project	This action removes the specified list of users as followers of a project.
Get a section	This action returns the records of a section.
Update a section	This action updates a section.
Delete a section	This action deletes an empty section.
Get sections in a project	This action returns a list of sections in a project.
Create a section in a project	This action creates a section in a project and returns the created section.
Add task to section	This action adds a task to a section and removes the newly added task from other sections of a project.
Move or insert sections	This action moves a section relative to the existing sections or inserts a section using either before_section parameter or after_section parameter.
Get a project status	This action retrieves the status updates of a project.
Delete a project status	This action deletes the status update of a project.
Get statuses from a project	This action returns the status updates from a project.
Create a project status	This action creates a status update on the project and returns the record of the created status update.
Get multiple tags	This action retrieves a set of tags based on the input parameter.
Create a tag	This action creates a tag in a workspace or organization and returns the record of the newly created tag.
Get a tag	This action returns the tag record for a specified tag.
Update a tag	This action updates the properties of a tag and returns the updated tag record.
Delete a tag	This action deletes a tag and returns an empty data record.
Get a tasks tags	This action returns the tags associated with a specified task.
Get tags in a workspace	This action returns the records of a tag in a workspace or in an organization based on the input parameters.
Create a tag in a workspace	This action creates a tag in a workspace or organization and returns the record of the newly created tag.
Get multiple tasks	This action retrieves a set of tasks based on the input parameters.
Create a task	This action creates a task in a workspace.
Get a task	This action returns the task record for a specified task.
Update a task	This action updates the fields of a specified task and returns the updated task record.
Duplicate a task	This action creates and returns an asynchronous job that duplicates a task.
Get tasks from a project	This action returns a list of tasks in a project.
Get tasks from a section	This action returns a list of tasks from a section.
Get tasks from a tag	This action returns a list of tasks in a tag.
Get tasks from a user task list	This action returns a list of tasks in a user's task list.
Get subtasks from a task	This action returns a list of subtasks in a task.
Create a subtask	This action creates a subtask and adds it to the parent task.
Set the parent of a task	This action sets the parent for a subtask.
Get dependencies from a task	This action returns the dependencies of a task.
Set dependencies for a task	This action marks a set of tasks as dependencies of a task.
Add a project to a task	This action adds a task to a project at the specified location.
Add a tag to a task	This action adds a tag to a task.
Add followers to a task	This action adds followers to a task.
Remove a tag from a task	This action removes a tag from a task.
Remove a project from a task	This action removes a task from a project.
Remove followers from a task	This action removes followers from a task and returns an updated list of followers.
Search tasks in a workspace	This action searches tasks in a workspace.
Create a team	This action creates a team in the current workspace.
Get a team	This action returns the record for a team.
Get teams in an workspace	This action returns a compact record of all teams in the workspace visible to the authorized user.
Get teams for a user	This action returns a list of teams assigned to a user.
Add a user to a team	This action adds a user from the organization to a team by an existing team member.
Remove a user from a team	This action removes a user from a team by a team member.
Get multiple users	This action returns a list of users in workspaces and organizations to authenticated users.
Get a user	This action returns a record of a user based on the input user ID.
Get users in a team	This action returns a list of users that are members of a team.
Get users in a workspace or organization	This action returns a list of users in a workspace or in an organization.
Get multiple workspaces	This action returns a list of workspaces to the authorized user.
Get a users task list	This action returns a list of user's task.
Get a projects custom fields	This action returns a list of custom fields settings of a project.

Configuration Parameters

The following configuration parameters are required for the Asana application to communicate with the Asana enterprise application. The parameters can be configured by creating instances in the Asana application.

Parameter	Description	Field Type	Required/Optional	Comments
Access Token	Enter the personal access token.	Password	Required

Action: Get Multiple Projects

This action retrieves compact project records based on the applied filters. You can use one or more parameters to filter the response.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Limit	Specify the number of results to retrieve on each page. Example: 50	Integer	Optional	Allowed Range: 1-100
Workspace	Enter the workspace or organization to filter the projects.	Text	Optional
Team	Enter the team to filter the projects.	Text	Optional	If the endpoints timeout for large domains, then filter the endpoints by the team parameter.
Archived	Enter true to only retrieve archived projects in the response.	Boolean	Optional	Default value: False
Offset	Enter the offset value to retrieve the next page in the response. You must use an offset that was returned to you from a previous paginated request. Example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9	Text	Optional	If an offset is not passed in, this action will return the first page of results.
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True
Opt Fields	Enter a comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: archived, color, completed, completed_at, completed_by, completed_by.name, created_at, created_from_template, created_from_template.name, current_status, current_status.author, current_status.author.name, current_status.color, current_status.created_at, current_status.created_by, current_status.created_by.name, current_status.html_text, current_status.modified_at, current_status.text, current_status.title, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings_custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.project, custom_field_settings.project.name, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.is_formula_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, default_access_level, default_view, due_date, due_on, followers, followers.name, html_notes, icon, members, members.name, minimum_access_level_for_customization, minimum_access_level_for_sharing, modified_at, name, notes, offset, owner, path, permalink_url, privacy_setting, project_brief, public, start_on, team, team.name, uri, workspace, workspace.name

Example Request

[
    {
        "limit": 100,
        "workspace": "SampleWorkspace",
        "team": "SampleTeam",
        "archived": true,
        "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
        "opt_pretty": true, 
        "opt_fields": "followers" 
 }
]

Action: Create a Project

This action creates a new project in a workspace or a team.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Name of Project	Enter the name of the project.	Text	Required
Description of Project	Enter the description of the project.	Text	Required
Team	Enter the name of the team to share the project with.	Text	Required	This field exists only for the projects in an organization.
Status Update Text	Enter the status update of the project through a text.	Text	Required
Status Update HTML Text	Enter the status update of the project through a text with an HTML formatting.	Text	Required
HTML Notes	Enter the notes for the project with an HTML formatting.	Text	Required
Color of Status	Enter the color associated with the status update.	Text	Optional	"Green" indicates project is on track, "yellow" indicates project is at risk, and "red" indicates project is behind.
Created by	Enter the project creator name.	Text	Optional	This is read-only except when the requester is same as creator.
Author Name	Enter the project author name.	Text	Optional	This is read-only except when the requester is same as author.
Status Update Title	Enter the title of the project's status update.	Text	Optional
Opt Fields	Define the optional fields to return. Example: $LIST[followers, assignee]	List	Optional	Optional fields: followers assignee
Extra Params	Enter the extra parameters.	Key Value	Optional	Allowed keys: custom_fields default_view due_on followers is_template public start_on owner archived color_of_project

Example Request

[
    {
        "name_of_project": "SampleProject",
        "description_of_project": "Sampledescription",
        "team": "Sampleteam",
        "status_update_text": "the project is in progress",
        "status_update_html_text": "the project is in progress",
        "html_notes": "this needs to be shared"
        "color_of_status": "green",
        "created_by": "John Doe",
        "author_name": "John Doe",
        "status_update_title": "Status update - June 15",
        "opt_fields": ["followers", "assignee"]   
    }
]

Action: Update a Project

This action updates the specified fields of a project and returns the updated project record.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of the project.	Text	Required
Status Update Text	Enter the status update of the project using a text.	Text	Required
Color of Status	Enter the color associated with the status update.	Text	Required	"Green" indicates project is on track, "yellow" indicates project is at risk, and "red" indicates project is behind.
Created by	Enter the project creator name.	Text	Optional
Author Name	Enter the project author name.	Text	Optional
Status Update HTML Text	Enter the status update of the project through a text with an HTML formatting.	Text	Optional
Status Update Title	Enter the title of the project's status update.	Text	Optional
Opt Fields	Define the optional fields to return. Example: $LIST[followers, assignee]	List	Optional	Optional fields: followers assignee
Extra Params	Enter the extra parameters.	Key Value	Optional	Allowed keys: name_of_project description_of_project owner archived color_of_project custom_fields default_view due_on followers html_notes is_template public start_on team

Example Request

[
    {
        "project_gid": "1234",
        "status_update_text": "the project is in progress",
        "color_of_status": "green",
        "created_by": "John Doe",
        "author_name": "John Doe",
        "status_update_html_text": "the project is in progress",
        "status_update_title": "Status update - June 15",
        "opt_fields": ["followers", "assignee"]
    }
]

Action: Get a Project

This action retrieves the complete details of the specified project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of the project. Example: 1201104610893418	Text	Required	You can retrieve this using the action Get Multiple Projects.
Opt Fields	Enter a comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: archived, color, completed, completed_at, completed_by, completed_by.name, created_at, created_from_template, created_from_template.name, current_status, current_status.author, current_status.author.name, current_status.color, current_status.created_at, current_status.created_by, current_status.created_by.name, current_status.html_text, current_status.modified_at, current_status.text, current_status.title, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings_custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.project, custom_field_settings.project.name, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.is_formula_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, default_access_level, default_view, due_date, due_on, followers, followers.name, html_notes, icon, members, members.name, minimum_access_level_for_customization, minimum_access_level_for_sharing, modified_at, name, notes, owner, permalink_url, privacy_setting, project_brief, public, start_on, team, team.name, workspace, workspace.name
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of the project.

Example:

1201104610893418

Text

Required

You can retrieve this using the action Get Multiple Projects.

Opt Fields

Enter a comma-separated list of fields to retrieve in the response.

List

Optional

Allowed values:

archived, color, completed, completed_at, completed_by, completed_by.name, created_at, created_from_template, created_from_template.name, current_status, current_status.author, current_status.author.name, current_status.color, current_status.created_at, current_status.created_by, current_status.created_by.name, current_status.html_text, current_status.modified_at, current_status.text, current_status.title, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings_custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.project, custom_field_settings.project.name, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.is_formula_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, default_access_level, default_view, due_date, due_on, followers, followers.name, html_notes, icon, members, members.name, minimum_access_level_for_customization, minimum_access_level_for_sharing, modified_at, name, notes, owner, permalink_url, privacy_setting, project_brief, public, start_on, team, team.name, workspace, workspace.name

Opt Pretty

Set this to true to retrieve the response in a 'pretty' format.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
  {
    "project_gid": "1201104610893418"
  }
]

Action: Duplicate a Project

This action creates and returns an asynchronous job that duplicates a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier for the project.	Text	Required
Name of New Project	Enter the name of the new project.	Text	Required
Include	Enter the elements of project that needs to be duplicated to the new project. Example: $LIST[members, task_notes]	List	Optional	When you duplicate a project, the tasks from the original projects are always included.
Team	Enter the team for the new project.	Text	Optional	If the entered team is not defined, then the new project will be in the same team as the original project.

Example Request

[
    {
        "project_gid": "12345",
        "name_of_new_project": "SampleProject",
        "include": ["members", "task_notes"],
        "team": "SampleTeam"
    }
]

Action: Get Projects a Task is in

This action returns a list of projects associated with a task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the task GID.	Text	Required
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the task GID.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get a Team's Projects

This action returns a list of projects associated with a team.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Team GID	Enter the globally unique identifier of a team.	Text	Required
Limit	Enter the number of results to be displayed per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True
Archived	Define this field to return archived projects.	Boolean	Optional	Default value: False

Example Request

[
    {
        "team_gid": "1234",
        "limit": 20,
        "opt_pretty": true,
        "archived": true
    }
]

Action: Create a Project in a Team

This action creates a project in a team.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Team GID	Enter the globally unique identifier of the team.	Text	Required
Name of Project	Enter the name of the project.	Text	Required
Description of Project	Enter the description of the project.	Text	Required
Status Update Text	Enter the status update of the project using a text.	Text	Required
Status Update HTML Text	Enter the status update of the project through a text with an HTML formatting.	Text	Required
HTML Notes	Enter the notes for the project with an HTML formatting.	Text	Required
Color of Status	Enter the color associated with the status update.	Text	Optional	"Green" indicates project is on track, "yellow" indicates project is at risk, and "red" indicates project is behind.
Created by	Enter the project creator name.	Text	Optional	This is read-only except when the requester is same as creator.
Author Name	Enter the project author name.	Text	Optional	This is read-only except when the requester is same as creator.
Status Update Title	Enter the title of the project's status update.	Text	Optional
Opt Fields	Define the optional fields to return. Example: $LIST[followers, assignee]	List	Optional	Optional fields: followers assignee
Extra Params	Enter the extra parameters.	Key Value	Optional	Allowed keys: owner archived color_of_project custom_fields default_view due_on followers is_template public start_on

Example Request

[
    {
        "team_gid": "1234",
        "name_of_project": "project1",
        "description_of_project": "project for task SampleProject",
        "status_update_text": "this is in progress",
        "status_update_html_text": "this is in progress",
        "html_notes": "the project for SampleTask",
        "color_of_status": "green",
        "created_by": "123",
        "author_name": "JohnSmith",
        "status_update_title": "in progress",
        "opt_fields": ["followers", "assignee"]   
    }
]

Action: Get all Projects in a Workspace

This action returns a list of projects in a workspace.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Workspace GID	Enter the globally unique identifier of the workspace or the organization.	Text	Required
Limit	Enter the number of results to be displayed per page.	Integer	Optional	Default Value: 100
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default Value: True
Archived	Choose to return archived projects.	Boolean	Optional

Example Request

[
    {
        "workspace_gid": "12345",
        "limit": 20,
        "opt_pretty": true,
        "archived": "123"
    }
]

Action: Add a Custom Field to a Project

<span>This action adds a custom field to a project.</span>

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter a globally unique identifier of a project.	Text	Required
Is Important	Enter a field name that is important to be displayed.	Boolean	Required
Custom Field	Enter a field that needs to be added to a project.	Text	Required
Insert after	Enter the field GID after which the required field needs to be added.	Text	Optional
Insert before	Enter the field GID before which the required field needs to be added.	Text	Optional
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "project_gid": "1234",
        "is_important": "followers",
        "custom_field": "213",
        "insert_after": "23",
        "insert_before": "24",
        "opt_pretty": true
    }
]

Action: Remove a Custom Field from a Project

This action removes a custom field from a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter a globally unique identifier of a project.

Text

Required

Custom Field

Enter the custom field.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "custom_field": "12",
        "opt_pretty": true
    }
]

Action: Add Users to a Project

This action add users to a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of a project.	Text	Required
Members	Enter the list of members.	Text	Required
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of a project.

Text

Required

Members

Enter the list of members.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "members": "11",
        "opt_pretty": true
    }
]

Action: Remove Users from a Project

This action removes a list of users from members of a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of a project.	Text	Required
Members	Enter the list of members.	Text	Required
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of a project.

Text

Required

Members

Enter the list of members.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "members": "SampleMember1", "SampleMember2",
        "opt_pretty": true
    }
]

Action: Add Followers to a Project

This action adds a list of followers to a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of a project.	Text	Required
Followers	Enter the list of members.	Text	Required
Opt Pretty	<div>Define this field to return pretty output.</div><div>The response with pretty output as an input parameter is displayed with proper line breaking and indentation.</div>	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of a project.

Text

Required

Followers

Enter the list of members.

Text

Required

Opt Pretty

<div>Define this field to return pretty output.</div><div>The response with pretty output as an input parameter is displayed with proper line breaking and indentation.</div>

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "followers": "SampleFollower1", "SampleFollower2",
        "opt_pretty": true
    }
]

Action: Remove Followers from a Project

This action removes a list of users from following the project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of a project.	Text	Required
Followers	Enter the list of followers.	Text	Required
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of a project.

Text

Required

Followers

Enter the list of followers.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "followers": "SampleFollower1", "SampleFollower2",
        "opt_pretty": true
    }
]

Action: Get a Section

This action returns a record for a section.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Section GID

Enter the globally unique identifier of a section.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "section_gid": "12345",
        "opt_pretty": true
    }
]

Action: Update a Section

This action updates a section.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Section GID	Enter the globally unique identifier of a section.	Text	Required
Name	Enter the section name.	Text	Required
Project	Enter the project name.	Text	Required
Insert after	Enter the section after which the required section needs to be moved.	Text	Optional
Insert before	Enter the section before which the required section needs to be moved.	Text	Optional
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "section_gid": "12345",
        "name": "SampleSection",
        "project": "SampleProject",
        "insert_after": "11",
        "insert_before": "12",
        "opt_pretty": true
    }
]

Action: Delete a Section

This action deletes an empty section. The last remaining section cannot be deleted.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Section GID

Enter the globally unique identifier of a section.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "section_gid": "12345",
        "opt_pretty": true
    }
]

Action: Get Sections in a Project

This action returns a list of sections in a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of the project.

Text

Required

Limit

Enter the number of results to be displayed per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "section_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Create a Section in a Project

This action creates a section in a project and returns the created section.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier for the project.

Text

Required

Name

Enter the name of the new section.

Text

Required

The section name cannot be an empty string.

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "name": "SampleSection",
        "opt_pretty": true
    }
]

Action: Add Task to Section

This action adds a task to a section and removes the newly added task from other sections of the project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Section GID	Enter the globally unique identifier of the section.	Text	Required
Task	Enter the task ID The task id to add to this section.	Text	Required
Insert after	Enter the task after which the required task needs to be moved.	Text	Optional
Insert before	Enter the task before which the required task needs to be moved.	Text	Optional
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "section_gid": "12345",
        "task": "789",
        "insert_after": "112233",
        "insert_before": "123",
        "opt_pretty": true
    }
]

Action: Move or Insert Sections

This action moves a section relative to the existing sections or inserts a section using either the before_section parameter or the after_section parameter.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of the project.	Text	Required
Section	Enter the section that needs to be moved.	Text	Required
After Section	Enter the section after which the required section needs to be moved.	Text	Optional
Before Section	Enter the section before which the required section needs to be moved.	Text	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "project_gid": "1234",
        "section": "20",
        "after_section": "22",
        "before_section": "23",
        "opt_pretty": true
    }
]

Action: Get a Project Status

This action retrieves the status updates of a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project Status GID	Enter the globally unique identifier of the project status.	Text	Required
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project Status GID

Enter the globally unique identifier of the project status.

Text

Required

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_status_gid": "1234",
        "opt_pretty": true
    }
]

Action: Delete a Project Status

This action deletes the status update of a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project Status GID	Enter the globally unique identifier of the project status.	Text	Required
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Project Status GID

Enter the globally unique identifier of the project status.

Text

Required

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_status_gid": "1234",
        "opt_pretty": true
    }
]

Action: Get Statuses from a Project

This action returns the status updates from a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project GID

Enter the globally unique identifier of the project.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "limit": "20",
        "opt_pretty": true
    }
]

Action: Create a Project Status

This action creates a status update on the project and returns the record of the created status update.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of the project.	Text	Required
Color	Enter the color associated with the status update.	Text	Required
Text	Enter the text for the status update.	Text	Required
Title	Enter the title of the status update.	Text	Required
HTML Text	Enter the status update through a text with an HTML formatting.	Text	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "project_gid": "1234",
        "color": "green",
        "text": "the project is in progress",
        "title": "In Progress",
        "html_text": "the project is in progress",
        "opt_pretty": true
    }
]

Action: Get Multiple Tags

This action retrieves a set of tags based on the input parameter.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Workspace	Enter the workspace.	Text	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Workspace

Enter the workspace.

Text

Optional

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "limit": "20",
        "workspace": "12345",
        "opt_pretty": true
    }
]

Action: Create a Tag

This action creates a tag in a workspace or organization and returns the record of the newly created tag.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Color	Enter the color of the tag.	Text	Required	You can choose any color for the tag.
Followers	Enter the followers for the tag. Example: $LIST[me, sampleemail@email.com]	List	Required	Accepted input for followers: Me User email ID User GID
Name	Enter the name for the tag.	Text	Required	Prefer a short tag name for better readability on the UI.
Workspace	Enter the workspace.	Text	Required
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "color": "light green",
        "followers": ["me", "samplefollower@email.com"],
        "name": "tag1",
        "workspace": "1234",
        "opt_pretty": true
    }
]

Action: Get a Tag

This action returns the record for a specified tag.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Tag GID

Enter the globally unique identifier of the tag.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "tag_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Update a Tag

This action updates the properties of a tag and returns the updated tag record.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Tag GID	Enter the globally unique identifier of the tag.	Text	Required
Color	Enter the color of the tag.	Text	Optional
Followers	Enter the followers of the tag. Example: $LIST[me, samplefollower@email.com]	List	Optional	Accepted input for followers: Me User email User GID
Name	Enter the name of the tag.	Text	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "tag_gid": "123",
        "color": "light green",
        "followers": ["me", "samplefollower@email.com"],
        "name": "tag1",
        "opt_pretty": true
    }
]

Action: Delete a Tag

This action deletes a tag and returns an empty data record.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Tag GID

Enter the globally unique identifier of the tag.

Text

Required

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "tag_gid": "12345",
        "opt_pretty": true
    }
]

Action: Get a Task's Tags

This action returns the tags associated with a specified task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of the tag.	Text	Required
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of the tag.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "tag_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get Tags in a Workspace

This action returns the records of a tag in a workspace or in an organization based on the input parameters.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Workspace GID

Enter the globally unique identifier of a workspace or an organization.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "workspace_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Create a Tag in a Workspace

This action creates a tag in a workspace or organization and returns the record of the newly created tag.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Workspace GID	Enter the globally unique identifier of a workspace or an organization.	Text	Required
Name	Enter the name for the tag.	Text	Required	Prefer a short tag name for better readability on the UI.
Color	Enter the color of the tag.	Text	Required	You can choose any color for the tag.
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "workspace_gid": "1234",
        "name": "tag1",
        "color": "light green",
        "opt_pretty": true
    }
]

Action: Get Multiple Tasks

This action retrieves a set of tasks based on the input parameters.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Assignee	Enter the assignee.	Text	Optional	If you specify the assignee, then you should also specify the workspace.
Workspace	Enter the workspace.	Text	Optional	If you specify the workspace, then you should also specify the assignee.
Project	Enter the project.	Text	Optional
Section	Enter the section.	Text	Optional	This parameter is only supported in board views.
Completed since	Enter the text in date-time format to filter the tasks that are either incomplete or are completed since the entered time.	Text	Optional
Modified since	Enter the text in date-time format to filter the tasks that are modified since the entered time.	Text	Optional
Limit	Enter the number of results to be displayed per page.	Integer	Optional	Default value:100
Opt pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "assignee": "124",
        "workspace": "1121",
        "project": "SampleProject",
        "section": "223",
        "completed_since": "2022-02-15",
        "modified_since": "2019-02-18", 
        "limit": 20, 
        "opt_pretty": true

    }
]

Action: Create a Task

This action creates a task in a workspace.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Name	Enter the name for the new task.	Text	Required
Workspace	Enter the globally unique identifier of a workspace.	Text	Required
Notes	Enter the description of the task.	Text	Required
Completed by name	Enter the assignee's name.	Text	Optional	Default value: Me
Followers	Enter the followers for the task. Example: $LIST[me, samplefollower@email.com]	List	Optional	To update the followers of a task, use addfollowers parameter and removefollowers parameter.
Assignee	Enter the globally unique identifier of assignee.	Text	Optional
Projects	Enter the globally unique identifier of the projects that the task needs to be a part of.	List	Optional
Tags	Enter the globally unique identifier of the tags that need to be associated with the task.	List	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional
Extra Params	Enter the extra parameters.	Key Value	Optional	Assigned keys: resource_subtype approval_status html_notes assignee_status assignee_section completed, due_at due_on liked, parent resource_subtype start_on custom_fields

Example Request

[
    {
        "name": "SampleTask",
        "workspace": "123",
        "notes": "the new task for SampleProject",
        "completed_by_name": "John Doe",
        "followers": ["me", "samplefollower@email.com"],
        "assignee": "John Doe",
        "projects": "123",
        "tags": "234"
        "opt_pretty": true
    }
]

Action: Get a Task

This action returns the task record for a specified task.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of the task.

Text

Required

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "12345",
        "opt_pretty": true
    }
]

Action: Update a Task

This action updates the fields of a specified task and returns the updated task record.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of the task.	Text	Required
Completed by name	Enter the assignee's name.	Text	Optional
Followers	Enter the followers name.	List	Optional
Html notes	Enter the notes for a task with HTML formatting.	Text	Optional
Name	Enter the name for a task.	Text	Optional
Notes	Enter the description for a task.	Text	Optional
Parent	Enter the parent GID.	Text	Optional
Workspace	Enter the workspace GID.	Text	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True
Extra params	Enter the extra parameters.	Key Value	Optional	Allowed keys: approval_status assignee assignee_section assignee_status completed due_at due_on projects, resource_subtype start_on tags liked custom_fields

Example Request

[
    {
        "task_gid": "1234",
        "completed_by_name": "John Doe",
        "followers": "223",
        "html_notes": "the task is part of project SampleProject",
        "name": "Task2",
        "notes": "the task is part of project SampleProject",
        "parent": "3331",
        "workspace": "1232",
        "opt_pretty": true   
    }
]

Action: Duplicate a Task

This action creates and returns an asynchronous job that duplicates a task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of the task.	Text	Required
Name	Enter the name for the new task.	Text	Required
Include	Define this field to include the notes or the assignees from the original task.	List	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "task_gid": "12345",
        "name": "SampleTask",
        "include": "notes",
        "opt_pretty": true
    }
]

Action: Get Tasks from a Project

This action retrieves compact task records for all tasks in the specified project, ordered by their priority.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Project GID	Enter the globally unique identifier of the project.	Text	Required	You can retrieve this using the action Get Multiple Projects.
Limit	Specify the number of results to retrieve on each page. Example: 50	Integer	Optional	Allowed range: 1-100
Offset	Enter the offset value to retrieve the next page in the response. You must use an offset that was returned to you from a previous paginated request. Example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9	Text	Optional	If an offset is not passed in, this action will return the first page of results.
Opt Fields	Enter a comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: actual_time_minutes, approval_status, assignee, assignee.name, assignee_section, assignee_section.name, assignee_status, completed, completed_at, completed_by, completed_by.name, created_at, created_by, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.id_prefix, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_value_read_only, custom_fields.is_enum_values, custom_fields.is_enum_values.color, custom_fields.is_enum_values.enabled, custom_fields.is_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, dependencies, dependents, due_at, due_on, external, external.data, followers, followers.name, hearted, hearts, hearts.user, hearts.user.name, html_notes, is_rendered_as_separator, liked, likes, likes.user, likes.user.name, memberships, memberships.project, memberships.project.name, memberships.section, memberships.section.name, modified_at, name, notes, num_hearts, num_likes, num_subtasks, offset, parent, parent.created_by, parent.name, parent.resource_subtype, path, permalink_url, projects, projects_name, resource_subtype, start_at, start_on, tags, tags.name, uri, workspace, workspace.name
Completed Since	Enter the date and time to retrieve tasks that are either incomplete or have been completed since this specified time. You can use the date and time format or the keyword 'now'. Example: 2012-02-22T02:06:58.158Z	Text	Optional
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "project_gid": "1201104610893418",
        "limit": "20",
        "opt_pretty": true
    }
]

Action: Get Tasks from a Section

This action returns a list of tasks from a section.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Section GID

Enter the globally unique identifier of the section.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "section_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get Tasks from a Tag

This action returns a list of tasks associated with a tag.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Tag GID

Enter the globally unique identifier of the tag.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "tag_gid": "12345",
        "limit": "20",
        "opt_pretty": true
    }
]

Action: Get tasks from a user task list

This action returns a list of tasks in a user's task list.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
User Task List GID	Enter the globally unique identifier of the user task list.	Text	Required	If the API-authenticated user does not have access to the user's private tasks, then the private tasks are not displayed.
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Parameter

Description

Field Type

Required/Optional

Comments

User Task List GID

Enter the globally unique identifier of the user task list.

Text

Required

If the API-authenticated user does not have access to the user's private tasks, then the private tasks are not displayed.

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "user_task_list_gid": "12345",
        "limit": "20",
        "opt_pretty": true
    }
]

Action: Get Subtasks from a Task

This action retrieves a compact record of all subtasks within a task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of the task to operate on.	Text	Required	You can retrieve this using the action Get Multiple Tasks.
Limit	Specify the number of results to retrieve on each page. Example: 50	Integer	Optional	Allowed Range: 1-100
Offset	Enter the offset value to retrieve the next page in the response. You must use an offset that was returned to you from a previous paginated request. Example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9	Text	Optional	If an offset is not passed in, this action will return the first page of results.
Opt Fields	Enter the comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: actual_time_minutes, approval_status, assignee, assignee.name, assignee_section, assignee_section.name, assignee_status, completed, completed_at, completed_by, completed_by.name, created_at, created_by, custom_fields, custom_fields.asana_created_field, custom_fields.created_by, custom_fields.created_by.name, custom_fields.currency_code, custom_fields.custom_label, custom_fields.custom_label_position, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.description, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.format, custom_fields.has_notifications_enabled, custom_fields.id_prefix, custom_fields.is_formula_field, custom_fields.is_global_to_workspace, custom_fields.is_value_read_only, custom_fields.is_enum_values, custom_fields.is_enum_values.color, custom_fields.is_enum_values.enabled, custom_fields.is_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.people_value, custom_fields.people_value.name, custom_fields.precision, custom_fields.representation_type, custom_fields.resource_subtype, custom_fields.text_value, custom_fields.type, dependencies, dependents, due_at, due_on, external, external.data, followers, followers.name, hearted, hearts, hearts.user, hearts.user.name, html_notes, is_rendered_as_separator, liked, likes, likes.user, likes.user.name, memberships, memberships.project, memberships.project.name, memberships.section, memberships.section.name, modified_at, name, notes, num_hearts, num_likes, num_subtasks, offset, parent, parent.created_by, parent.name, parent.resource_subtype, path, permalink_url, projects, projects_name, resource_subtype, start_at, start_on, tags, tags.name, uri, workspace, workspace.name
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "task_gid": "321654",
        "limit": "20",
        "opt_pretty": true
    }
]

Action: Create a Subtask

This action creates a subtask and adds it to the parent task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of the parent task.	Text	Required
Name	Enter the name for the subtask.	Text	Required
Workspace	Enter the globally unique identifier of a workspace.	Text	Required
Notes	Enter description for the subtask.	Text	Required
Completed	Enter the assignee's name	Text	Optional
Followers	Enter the followers for the subtask.	List	Optional
Assignee	Enter the globally unique identifier of the assignee.	Text	Optional
Projects	Enter the globally unique identifier of the projects to be associated with the subtask.	List	Optional
Tags	Enter the globally unique identifier of the tags to be associated with the subtask.	List	Optional
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True
Extra Params	Enter the extra parameters.	Key Value	Optional	Allowed keys: resource_subtype approval_status html_notes assignee_status assignee_section completed due_at liked, parent start_on custom_fields

Example Request

[
    {
        "task_gid": "abc",
        "name": "SampleSubtask",
        "workspace": "123",
        "notes": "the new subtask for SampleTask",
        "completed_by_name": "John Doe",
        "followers": "me",
        "assignee": "123",
        "projects": "123",
        "tags": "234",
        "opt_pretty": true
    }
]

Action: Set the Parent of a Task

This action sets the parent for a subtask.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of a task.	Text	Required
Parent	Enter the globally unique identifier of a parent.	Text	Required
Insert after	Enter the existing subtask of a parent to insert after.	Text	Optional	Default position: Beginning of list
Insert before	Enter the existing subtask of a parent to insert before.	Text	Optional	Default position: Ending of list
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "task_gid": "100",
        "parent": "123",
        "insert_after": "22",
        "insert_before": "23",
        "opt_pretty":  true

    }
]

Action: Get Dependencies from a Task

This action returns the dependencies of a task.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Limit

Enter the number of results to be displayed per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Set Dependencies for a Task

This action sets dependencies for a task. A task can have a maximum of 15 dependencies.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Dependencies

Enter the number of dependencies to be displayed per page.

Text

Required

Opt Pretty

Define this field to return pretty output.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "12345",
        "dependencies": 10,
        "opt_pretty": true
    }
]

Action: Add a Project to a Task

This action adds a task to a project.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Task GID	Enter the globally unique identifier of a task.	Text	Required
Project	Enter the globally unique identifier of project.	Text	Required
Insert after	Enter the existing task of a project to insert after.	Text	Optional
Insert before	Enter the existing task of a project to insert before.	Text	Optional
Section	Enter the globally unique identifier of a section to insert a task into.	Text	Optional	Default location: Bottom of section
Opt Pretty	Define this field to return pretty output.	Boolean	Optional	Default value: True

Example Request

[
    {
        "task_gid": "100",
        "project": "123",
        "insert_after": "22",
        "insert_before": "23",
        "section": "123",
        "opt_pretty":  true

    }
]

Action: Add a Tag to a Task

This action adds a tag to a task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Task GID	Enter the globally unique identifier of a task.	Text	Required
Tag	Enter the globally unique identifier of a tag.	Text	Required
Opt Pretty	Define this field to return pretty output.	Boolean	Optional

Example Request

[
    {
        "task_gid": "100",
        "tag": "123",
        "opt_pretty": true

    }
]

Action: Add Followers to a Task

This action adds followers to a task.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Followers

Enter the list of followers.

Text

Required

Opt Pretty

Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "100",
        "followers": "123",
        "opt_pretty": true

    }
]

Action: Remove a Tag from a Task

This action removes a tag from a task.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Tag

Enter the globally unique identifier of the tag.

Text

Required

Opt pretty

Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "100",
        "tag": "123",
        "opt_pretty": true

    }
]

Action: Remove a Project from a Task

This action removes a task from a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Project

Enter the globally unique identifier of the project.

Text

Required

Opt Pretty

Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "100",
        "project": "123",
        "opt_pretty": true

    }
]

Action: Remove Followers from a Task

This action removes followers from a task and returns an updated list of followers.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Task GID

Enter the globally unique identifier of a task.

Text

Required

Followers

Enter the list of followers.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "task_gid": "100",
        "followers": "123",
        "opt_pretty": true
    }
]

Action: Search Tasks in a Workspace

This action searches tasks in a workspace.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Workspace GID	Enter the globally unique identifier of a workspace or an organization.	Text	Required
Text	Enter the text related to task name or task description to perform a search operation.	Text	Optional
Resource Subtype	Enter the task's resource_subtype.	Text	Optional
Assignee Any	Enter the list of user identifiers.	Text	Optional
Assignee Not	Enter the list of user identifiers.	Text	Optional
Projects Any	Enter the list of project GIDs.	Text	Optional
Projects Not	Enter the list of project GIDs.	Text	Optional
Projects All	Enter the list of Project GIDs.	Text	Optional
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True
Extra Params	Enter the extra parameters.	Key Value	Optional	Allowed keys: sections_any sections_not sections_all tags_any tags_not tags_all

Example Request

[
    {
        "workspace_gid": "123",
        "text": "task1",
        "resource_subtype": "bug task",
        "assignee_any": "123",
        "assignee_not": "22",
        "projects_any": "23"
        "projects_not": "24",
        "projects_all": "31",
        "opt_pretty": true
    }
]

Action: Create a Team

This action creates a team in the current workspace.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Description	Enter the description of the team.	Text	Required
HTML Description	Enter the description of the team with HTML formatting.	Text	Required
Name	Enter the name of the team.	Text	Required
Organization	Enter the organization or the workspace associated with the team.	Text	Required
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "description": "team for SampleProject deliverable",
        "html_description": "team for SampleProject deliverable",
        "name": "team abc",
        "organization": "123",
        "opt_pretty": true
    }
]

Action: Get a Team

This action returns the record for a team.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team GID

Enter the globally unique identifier of the team.

Text

Required

Limit

Enter the number of results to be displayed per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "team_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get Teams in a Workspace

This action returns a list of teams in the workspace visible to the authorized user.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Workspace GID	Enter the globally unique identifier of a workspace or an organization.	Text	Required	You can retrieve this using the action Get Multiple Workspaces.
Limit	Specify the number of results to retrieve on each page. Example: 50	Integer	Optional	Allowed range: 1-100
Offset	Enter the offset value to retrieve the next page in the response. You must use an offset that was returned to you from a previous paginated request. Example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9	Text	Optional	If an offset is not passed in, this action will return the first page of results.
Opt Fields	Enter a comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: description, edit_team_name_or_description_access_level, edit_team_visibilty_or_trash_team_access_level, guest_invite_management_access_level, html_description, join_request_management_access_level, member_invite_management_access_level, name, offset, organization, organization.name, path, permalink_url, team_member_removal_access_level, uri, visibility
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "workspace_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get Teams for a User

This action returns a list of teams assigned to a user.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
User GID	Enter the globally unique identifier of a user.	Text	Required
Organization	Enter a workspace or an organization.	Text	Required
Limit	Enter the number of results to be displayed per page.	Integer	Optional	Default value: 100
Opt pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "user_gid": "12345",
        "organization": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Add a User to a Team

This action adds a user from the organization to a team by an existing team member.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team GID

Enter the globally unique identifier of the team.

Text

Required

User

Enter the globally unique identifier of a user.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "team_gid": "12345",
        "user": "20",
        "opt_pretty": true
    }
]

Action: Remove a user from a team

This action removes a user from a team by a team member.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Team gid	Globally unique identifier for the team.	Text	Required
User	A string identifying a user. this can either be the string "me", an email, or the gid of a user.	Text	Required
Opt pretty	Provides “pretty” output. defaults to true	Boolean	Optional

Example Request

[
    {
        "team_gid": "12345",
        "user": "20",
        "opt_pretty": true
    }
]

Action: Get Multiple Users

This action returns a list of users in workspaces and organizations to the authenticated users.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Workspace	The workspace or organization id to filter users on.	Text	Optional
Team	Enter the globally unique identifier of the team.	Text	Optional
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "workspace": "12345",
        "team": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get a User

This action returns a record of a user based on the input user ID.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

User gid

Enter the globally unique identifier of the task.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value: True

Example Request

[
    {
        "user_gid": "12345",
        "opt_pretty": true
    }
]

Action: Get Users in a Team

This action returns a list of users that are members of a team.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team GID

Enter the globally unique identifier of a team.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "team_gid": "12345",
        "opt_pretty": true
    }
]

Action: Get Users in a Workspace or Organization

This action returns a list of users in a workspace or in an organization.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Workspace GID

Enter the globally unique identifier of a workspace or an organization.

Text

Required

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "workspace_gid": "12345",
        "opt_pretty": true
    }
]

Action: Get Multiple Workspaces

This action retrieves compact records of all workspaces visible to the authorized user.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Limit	Specify the number of results to retrieve on each page. Example: 50	Integer	Optional	Allowed Range: 1-100
Offset	Enter the offset value to retrieve the next page in the response. You must use an offset that was returned to you from a previous paginated request. Example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9	Text	Optional	If an offset is not passed in, this action will return the first page of results.
Opt Fields	Enter a comma-separated list of fields to retrieve in the response.	List	Optional	Allowed values: email_domains, is_organization, name, offset, path, uri
Opt Pretty	Set this to true to retrieve the response in a 'pretty' format. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get a User's Task List

This action returns a list of user's task.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
User GID	Enter the globally unique identifier of a user.	Text	Required
Workspace	Enter the workspace GID.	Text	Required
Limit	Enter the required number of results per page.	Integer	Optional	Default value: 100
Opt Pretty	Define this field to return pretty output. The response with pretty output as an input parameter is displayed with proper line breaking and indentation.	Boolean	Optional	Default value: True

Example Request

[
    {
        "user_gid": "12345",
        "workspace": "12345",        
        "limit": 20,
        "opt_pretty": true
    }
]

Action: Get a Projects Custom Fields

This action returns a list of custom fields settings of a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project gid

Enter the globally unique identifier of a project.

Text

Required

Limit

Enter the required number of results per page.

Integer

Optional

Default value:

100

Opt Pretty

Define this field to return pretty output.

The response with pretty output as an input parameter is displayed with proper line breaking and indentation.

Boolean

Optional

Default value:

True

Example Request

[
    {
        "project_gid": "12345",
        "limit": 20,
        "opt_pretty": true
    }
]

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.

Cyware Orchestrate

Asana

About App

Configuration Parameters

Action: Get Multiple Projects

Action: Create a Project

Action: Update a Project

Action: Get a Project

Action: Duplicate a Project

Action: Get Projects a Task is in

Action: Get a Team's Projects

Action: Create a Project in a Team

Action: Get all Projects in a Workspace

Action: Add a Custom Field to a Project

Action: Remove a Custom Field from a Project

Action: Add Users to a Project

Action: Remove Users from a Project

Action: Add Followers to a Project

Action: Remove Followers from a Project

Action: Get a Section

Action: Update a Section

Action: Delete a Section

Action: Get Sections in a Project

Action: Create a Section in a Project

Action: Add Task to Section

Action: Move or Insert Sections

Action: Get a Project Status

Action: Delete a Project Status

Action: Get Statuses from a Project

Action: Create a Project Status

Action: Get Multiple Tags

Action: Create a Tag

Action: Get a Tag

Action: Update a Tag

Action: Delete a Tag

Action: Get a Task's Tags

Action: Get Tags in a Workspace

Action: Create a Tag in a Workspace

Action: Get Multiple Tasks

Action: Create a Task

Action: Get a Task

Action: Update a Task

Action: Duplicate a Task

Action: Get Tasks from a Project

Action: Get Tasks from a Section

Action: Get Tasks from a Tag

Action: Get tasks from a user task list

Action: Get Subtasks from a Task

Action: Create a Subtask

Action: Set the Parent of a Task

Action: Get Dependencies from a Task

Action: Set Dependencies for a Task

Action: Add a Project to a Task

Action: Add a Tag to a Task

Action: Add Followers to a Task

Action: Remove a Tag from a Task

Action: Remove a Project from a Task

Action: Remove Followers from a Task

Action: Search Tasks in a Workspace

Action: Create a Team

Action: Get a Team

Action: Get Teams in a Workspace

Action: Get Teams for a User

Action: Add a User to a Team

Action: Remove a user from a team

Action: Get Multiple Users

Action: Get a User

Action: Get Users in a Team

Action: Get Users in a Workspace or Organization

Action: Get Multiple Workspaces

Action: Get a User's Task List

Action: Get a Projects Custom Fields

Search results