Asana Connector for PowerShell
In this article you will learn how to quickly and efficiently
integrate Asana data in PowerShell without coding.
We will use high-performance Asana Connector
to easily connect to Asana and then access the data inside PowerShell.
Read and write data related to Tasks, Projects, Workspaces, Portfolios, TimeEntries, Memberships and more.
Let's follow the steps below to see how we can accomplish that!
Download
Documentation
Asana Connector for PowerShell is based on ZappySys API Driver
which is part of ODBC PowerPack.
It is a collection of high-performance ODBC drivers that enable you
to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application.
ODBC PowerPack supports various file formats, sources and destinations,
including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.
|
Connect to Asana in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Asana using PowerShell we first need to create a DSN (Data Source)
which will access data from Asana. We will later be able to read data using PowerShell. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019.
Use it for both type of applications - 64-bit and 32-bit.
-
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use in a production environment.
Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
When the Configuration window appears give your data source a name if you haven't done that already,
then select "Asana" from the list of Popular Connectors. If "Asana" is not present
in the list, then click "Search Online" and download it. Then set the path to the location where you
downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
AsanaDSN
Asana
-
Now it's time to configure the Connection Manager. Select Authentication Type,
e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one).
More info is available in the Authentication section.
Steps how to get and use Asana credentials
Here is how to obtain a Personal Access Token (PAT) in Asana:
-
Open My apps in Asana portal
and click Create new token button:
-
Once a popup opens, name your new token:
-
Then click Copy button to copy the token:
-
Now go to SSIS package or ODBC data source and use this token in Personal Access Token authentication configuration.
-
Choose Default Workspace and Default Project to work with.
-
Click Test Connection to confirm the connection is working.
-
Done! Now you are ready to use Asana Connector!
Fill in all required parameters and set optional parameters if needed:
AsanaDSN
Asana
Personal Access Token [Http]
https://app.asana.com/api/1.0
Steps how to get and use Asana credentials
Here is how to register an OAuth app in Asana:
-
Open My apps in Asana portal
and click Create new app button:
-
Once a popup opens, name your app and check two options, and click Create app button:
-
Then copy Client ID and Client secret and save them in a file (we will need them for authentication):
-
Continue by selecting OAuth menu item on your left and click Add redirect URL button (you can have your own or use
https://zappysys.com/oauth
):
-
Proceed by clicking on the Manage distribution section on your left.
-
Then specify workspaces your app needs to access (use Any workspace to access them all):
-
Once you do that, click Save changes button.
-
Now go to SSIS package or ODBC data source and use
Client ID, Client Secret, and Redirect URL in OAuth app authentication configuration.
-
When you are done with that, click Generate Token button to generate Access and Refresh Tokens.
-
Choose Default Workspace and Default Project to work with.
-
Click Test Connection to confirm the connection is working.
-
Done! Now you are ready to use Asana Connector!
Fill in all required parameters and set optional parameters if needed:
AsanaDSN
Asana
OAuth app [OAuth]
https://app.asana.com/api/1.0
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read Asana data in PowerShell
Sometimes, you need to quickly access and work with your Asana data in PowerShell.
Whether you need a quick data overview or the complete dataset, this article will guide you through the process.
Here are some common scenarios:
Viewing data in a terminal
- Quickly peek at Asana data
- Monitor data constantly in your console
Saving data to a file
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
Saving data to a database
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
Sending data to another API
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file.
But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=AsanaDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=AsanaDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"
# Display data in the console
foreach ($row in $table.Rows)
{
# Construct line based on the format and individual Asana fields
$line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
Write-Host $line
}
Access specific Asana table field using this code snippet:
$field = $row["ColumnName"]
You will find more info on how to manipulate
DataTable.Rows
property in
Microsoft .NET reference.
For demonstration purposes we are using sample tables which may not be available in Asana.
-
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
"DSN=AsanaDSN"
Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=AsanaDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
You can limit the numbers of lines to retrieve by using a
LIMIT
keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN.
Yet sometimes you don't want a dependency on an ODBC data source (and an extra step).
In those times, you can define a full connection string and skip creating an ODBC data source entirely.
Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - Asana
Read and write data related to Tasks, Projects, Workspaces, Portfolios, TimeEntries, Memberships and more.
AsanaDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation:
it's length is limited to 1024 symbols (or sometimes more).
It usually happens when API provider generates a very long Refresh Token when OAuth is at play.
If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
- Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.
Write Asana data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=AsanaDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
Check useful
PowerShell cmdlets other than
ConvertTo-Csv
,
ConvertTo-Json
, and
ConvertTo-Html
for other data manipulation scenarios.
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders]
@fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
AS
SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([LINKED_SERVER_TO_ASANA_IN_DATA_GATEWAY], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT
"ShipCountry",
"OrderID",
"CustomerID",
"EmployeeID",
"OrderDate",
"RequiredDate",
"ShippedDate",
"ShipVia",
"Freight",
"ShipName",
"ShipAddress",
"ShipCity",
"ShipRegion",
"ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([LINKED_SERVER_TO_ASANA_IN_DATA_GATEWAY], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Asana Connector
Asana Connector support following actions for REST API integration.
If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
[
Read more...
]
Parameter |
Description |
QueryBy |
Option |
Value |
project |
project |
tag |
tag |
section |
section |
user_task_list |
user_task_list |
assignee_and_workspace |
assignee_and_workspace |
|
Project Id |
The project to filter tasks on.
|
Workspace Id |
The workspace to filter tasks on. Note: If you specify workspace, you must also specify the assignee to filter on.
|
Assignee Id |
The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. Note: If you specify assignee, you must also specify the workspace to filter on.
|
Section Id |
The section to filter tasks on.
|
Tag Id |
|
UserTaskListId |
|
Completed Since |
Only return tasks that are either incomplete or that have been completed since this time.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified Since |
Only return tasks that have been modified since the given time. Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Only enter TaskId if QueryBy=task else you may get error. [
Read more...
]
Parameter |
Description |
QueryBy |
Option |
Value |
project |
project |
task |
task |
tag |
tag |
section |
section |
user_task_list |
user_task_list |
assignee_and_workspace |
assignee_and_workspace |
|
Parent Task Id |
The parent task id for which you would like to fetch all sub tasks.
|
Project Id |
The project to filter tasks on.
|
Workspace Id |
The workspace to filter tasks on. Note: If you specify workspace, you must also specify the assignee to filter on.
|
Assignee Id |
The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. Note: If you specify assignee, you must also specify the workspace to filter on.
|
Section Id |
The section to filter tasks on.
|
Tag Id |
|
UserTaskListId |
|
Completed Since |
Only return tasks that are either incomplete or that have been completed since this time.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified Since |
Only return tasks that have been modified since the given time. Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Get tasks for all projects in a specified workspace (or default workspace). [
Read more...
]
Parameter |
Description |
Fields |
Option |
Value |
actual_time_minutes |
actual_time_minutes |
subtasks |
subtasks |
approval_status |
approval_status |
assignee |
assignee |
assignee.name |
assignee.name |
assignee_section |
assignee_section |
assignee_section.name |
assignee_section.name |
assignee_status |
assignee_status |
completed |
completed |
completed_at |
completed_at |
completed_by |
completed_by |
completed_by.name |
completed_by.name |
created_at |
created_at |
created_by |
created_by |
created_by.name |
created_by.name |
custom_fields |
custom_fields |
custom_fields.asana_created_field |
custom_fields.asana_created_field |
custom_fields.created_by |
custom_fields.created_by |
custom_fields.created_by.name |
custom_fields.created_by.name |
custom_fields.currency_code |
custom_fields.currency_code |
custom_fields.custom_label |
custom_fields.custom_label |
custom_fields.custom_label_position |
custom_fields.custom_label_position |
custom_fields.date_value |
custom_fields.date_value |
custom_fields.date_value.date |
custom_fields.date_value.date |
custom_fields.date_value.date_time |
custom_fields.date_value.date_time |
custom_fields.description |
custom_fields.description |
custom_fields.display_value |
custom_fields.display_value |
custom_fields.enabled |
custom_fields.enabled |
custom_fields.enum_options |
custom_fields.enum_options |
custom_fields.enum_options.color |
custom_fields.enum_options.color |
custom_fields.enum_options.enabled |
custom_fields.enum_options.enabled |
custom_fields.enum_options.name |
custom_fields.enum_options.name |
custom_fields.enum_value |
custom_fields.enum_value |
custom_fields.enum_value.color |
custom_fields.enum_value.color |
custom_fields.enum_value.enabled |
custom_fields.enum_value.enabled |
custom_fields.enum_value.name |
custom_fields.enum_value.name |
custom_fields.format |
custom_fields.format |
custom_fields.has_notifications_enabled |
custom_fields.has_notifications_enabled |
custom_fields.id_prefix |
custom_fields.id_prefix |
custom_fields.is_formula_field |
custom_fields.is_formula_field |
custom_fields.is_global_to_workspace |
custom_fields.is_global_to_workspace |
custom_fields.is_value_read_only |
custom_fields.is_value_read_only |
custom_fields.multi_enum_values |
custom_fields.multi_enum_values |
custom_fields.multi_enum_values.color |
custom_fields.multi_enum_values.color |
custom_fields.multi_enum_values.enabled |
custom_fields.multi_enum_values.enabled |
custom_fields.multi_enum_values.name |
custom_fields.multi_enum_values.name |
custom_fields.name |
custom_fields.name |
custom_fields.number_value |
custom_fields.number_value |
custom_fields.people_value |
custom_fields.people_value |
custom_fields.people_value.name |
custom_fields.people_value.name |
custom_fields.precision |
custom_fields.precision |
custom_fields.representation_type |
custom_fields.representation_type |
custom_fields.resource_subtype |
custom_fields.resource_subtype |
custom_fields.text_value |
custom_fields.text_value |
custom_fields.type |
custom_fields.type |
dependencies |
dependencies |
dependents |
dependents |
due_at |
due_at |
due_on |
due_on |
external |
external |
external.data |
external.data |
followers |
followers |
followers.name |
followers.name |
hearted |
hearted |
hearts |
hearts |
hearts.user |
hearts.user |
hearts.user.name |
hearts.user.name |
html_notes |
html_notes |
is_rendered_as_separator |
is_rendered_as_separator |
liked |
liked |
likes |
likes |
likes.user |
likes.user |
likes.user.name |
likes.user.name |
memberships |
memberships |
memberships.project |
memberships.project |
memberships.project.name |
memberships.project.name |
memberships.section |
memberships.section |
memberships.section.name |
memberships.section.name |
modified_at |
modified_at |
name |
name |
notes |
notes |
num_hearts |
num_hearts |
num_likes |
num_likes |
num_subtasks |
num_subtasks |
parent |
parent |
parent.created_by |
parent.created_by |
parent.name |
parent.name |
parent.resource_subtype |
parent.resource_subtype |
permalink_url |
permalink_url |
projects |
projects |
projects.name |
projects.name |
resource_subtype |
resource_subtype |
start_at |
start_at |
start_on |
start_on |
tags |
tags |
tags.name |
tags.name |
workspace |
workspace |
workspace.name |
workspace.name |
|
Workspace Id |
The workspace to filter tasks on. Note: If you specify workspace.
|
Completed Since |
Only return tasks that are either incomplete or that have been completed since this time.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified Since |
Only return tasks that have been modified since the given time. Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Search Tasks (Advanced Filter)
Search tasks with in a specified workspace (or default workspace) using advanced server side filters. [
Read more...
]
Parameter |
Description |
Fields |
Option |
Value |
actual_time_minutes |
actual_time_minutes |
subtasks |
subtasks |
approval_status |
approval_status |
assignee |
assignee |
assignee.name |
assignee.name |
assignee_section |
assignee_section |
assignee_section.name |
assignee_section.name |
assignee_status |
assignee_status |
completed |
completed |
completed_at |
completed_at |
completed_by |
completed_by |
completed_by.name |
completed_by.name |
created_at |
created_at |
created_by |
created_by |
created_by.name |
created_by.name |
custom_fields |
custom_fields |
custom_fields.asana_created_field |
custom_fields.asana_created_field |
custom_fields.created_by |
custom_fields.created_by |
custom_fields.created_by.name |
custom_fields.created_by.name |
custom_fields.currency_code |
custom_fields.currency_code |
custom_fields.custom_label |
custom_fields.custom_label |
custom_fields.custom_label_position |
custom_fields.custom_label_position |
custom_fields.date_value |
custom_fields.date_value |
custom_fields.date_value.date |
custom_fields.date_value.date |
custom_fields.date_value.date_time |
custom_fields.date_value.date_time |
custom_fields.description |
custom_fields.description |
custom_fields.display_value |
custom_fields.display_value |
custom_fields.enabled |
custom_fields.enabled |
custom_fields.enum_options |
custom_fields.enum_options |
custom_fields.enum_options.color |
custom_fields.enum_options.color |
custom_fields.enum_options.enabled |
custom_fields.enum_options.enabled |
custom_fields.enum_options.name |
custom_fields.enum_options.name |
custom_fields.enum_value |
custom_fields.enum_value |
custom_fields.enum_value.color |
custom_fields.enum_value.color |
custom_fields.enum_value.enabled |
custom_fields.enum_value.enabled |
custom_fields.enum_value.name |
custom_fields.enum_value.name |
custom_fields.format |
custom_fields.format |
custom_fields.has_notifications_enabled |
custom_fields.has_notifications_enabled |
custom_fields.id_prefix |
custom_fields.id_prefix |
custom_fields.is_formula_field |
custom_fields.is_formula_field |
custom_fields.is_global_to_workspace |
custom_fields.is_global_to_workspace |
custom_fields.is_value_read_only |
custom_fields.is_value_read_only |
custom_fields.multi_enum_values |
custom_fields.multi_enum_values |
custom_fields.multi_enum_values.color |
custom_fields.multi_enum_values.color |
custom_fields.multi_enum_values.enabled |
custom_fields.multi_enum_values.enabled |
custom_fields.multi_enum_values.name |
custom_fields.multi_enum_values.name |
custom_fields.name |
custom_fields.name |
custom_fields.number_value |
custom_fields.number_value |
custom_fields.people_value |
custom_fields.people_value |
custom_fields.people_value.name |
custom_fields.people_value.name |
custom_fields.precision |
custom_fields.precision |
custom_fields.representation_type |
custom_fields.representation_type |
custom_fields.resource_subtype |
custom_fields.resource_subtype |
custom_fields.text_value |
custom_fields.text_value |
custom_fields.type |
custom_fields.type |
dependencies |
dependencies |
dependents |
dependents |
due_at |
due_at |
due_on |
due_on |
external |
external |
external.data |
external.data |
followers |
followers |
followers.name |
followers.name |
hearted |
hearted |
hearts |
hearts |
hearts.user |
hearts.user |
hearts.user.name |
hearts.user.name |
html_notes |
html_notes |
is_rendered_as_separator |
is_rendered_as_separator |
liked |
liked |
likes |
likes |
likes.user |
likes.user |
likes.user.name |
likes.user.name |
memberships |
memberships |
memberships.project |
memberships.project |
memberships.project.name |
memberships.project.name |
memberships.section |
memberships.section |
memberships.section.name |
memberships.section.name |
modified_at |
modified_at |
name |
name |
notes |
notes |
num_hearts |
num_hearts |
num_likes |
num_likes |
num_subtasks |
num_subtasks |
parent |
parent |
parent.created_by |
parent.created_by |
parent.name |
parent.name |
parent.resource_subtype |
parent.resource_subtype |
permalink_url |
permalink_url |
projects |
projects |
projects.name |
projects.name |
resource_subtype |
resource_subtype |
start_at |
start_at |
start_on |
start_on |
tags |
tags |
tags.name |
tags.name |
workspace |
workspace |
workspace.name |
workspace.name |
|
Workspace Id |
The workspace to filter tasks on. Note: If you specify workspace.
|
Text |
Performs full-text search on both task name and description.
|
Projects (NOT) |
Comma-separated list of project IDs.
|
Projects (ALL) |
Comma-separated list of project IDs.
|
Projects (ANY) |
Comma-separated list of project IDs.
|
Sections (NOT) |
Comma-separated list of section IDs.
|
Sections (ALL) |
Comma-separated list of section IDs.
|
Sections (ANY) |
Comma-separated list of section IDs.
|
Tags (NOT) |
Comma-separated list of tag IDs.
|
Tags (ALL) |
Comma-separated list of tag IDs.
|
Tags (ANY) |
Comma-separated list of tag IDs.
|
Assigned By (NOT) |
Comma-separated list of user IDs.
|
Assigned By (ALL) |
Comma-separated list of user IDs.
|
Assigned By (ANY) |
Comma-separated list of user IDs.
|
Portfolios (ANY) |
Comma-separated list of portfolio IDs.
|
Teams (ANY) |
Comma-separated list of team IDs.
|
Due On |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Due On Before |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Due On After |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Due On (Null) |
Search for DueOn [null] value.
|
Start On |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start On Before |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start On After |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start On (Null) |
Search for StartOn [null] value.
|
Created On |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created On Before |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created On After |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created On (Null) |
Search for CreatedOn [null] value.
|
Modified On |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified On Before |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified On After |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified On (Null) |
Search for ModifiedOn [null] value.
|
Completed On |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed On Before |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed On After |
ISO 8601 date string (e.g. 2025-12-31).
Option |
Value |
2023-12-31 |
2023-12-31 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed On (Null) |
Search for CompletedOn [null] value.
|
Due At |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Due At Before |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Due At After |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start At |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start At Before |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Start At After |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created At |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created At Before |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Created At After |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified At |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified At Before |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Modified At After |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed At |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed At Before |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Completed At After |
ISO 8601 date string (e.g. 2025-12-31T23:59:59).
Option |
Value |
2023-12-31 |
2023-12-31 |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
now-24h |
now-24h |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
Is Blocked |
Option |
Value |
true |
true |
false |
false |
|
Is Blocking |
Option |
Value |
true |
true |
false |
false |
|
Is Subtask |
Option |
Value |
true |
true |
false |
false |
|
Has Attachment |
Option |
Value |
true |
true |
false |
false |
|
Completed |
Option |
Value |
true |
true |
false |
false |
|
Sort By |
Option |
Value |
due_date |
due_date |
created_at |
created_at |
completed_at |
completed_at |
modified_at |
modified_at |
likes |
likes |
|
Sort Ascending |
Option |
Value |
true |
true |
false |
false |
|
Returns records for all teams in the workspace visible to the authorized user. [
Read more...
]
Parameter |
Description |
Workspace Id |
|
[
Read more...
]
Parameter |
Description |
Project Id |
|
Section Id |
|
[
Read more...
]
Parameter |
Description |
Workspace Id |
|
Project Id |
|
User Id |
|
Get Attachments (For Project refer to Key-Resources Upload only)
There are three possible parent values for this request: project, project_brief, and task. For a project, an attachment refers to a file uploaded to the [Key resources] section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to GET /attachments for a task will return all of the images in the task, including inline images. [
Read more...
]
Parameter |
Description |
Parent Id (e.g. Id of Project, Task or ProjectBrief) |
Globally unique identifier for object to fetch statuses from. Must be a GID for a project, project_brief, or task.
|
Download a specific attachment by Id. [
Read more...
]
Parameter |
Description |
Attachment ID |
The attachment Id for the attachment to get.
|
Fields |
Option |
Value |
name |
name |
resource_subtype |
resource_subtype |
connected_to_app |
connected_to_app |
created_at |
created_at |
download_url |
download_url |
host |
host |
parent |
parent |
parent.name |
parent.name |
parent.resource_subtype |
parent.resource_subtype |
permanent_url |
permanent_url |
size |
size |
view_url |
view_url |
|
Download Multiple Attachments
Download Multiple Attachments for a specified parent.There are three possible parent values for this request: project, project_brief, and task. For a project, an attachment refers to a file uploaded to the [Key resources] section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to GET /attachments for a task will return all of the images in the task, including inline images. [
Read more...
]
Parameter |
Description |
Parent Id (e.g. Id of Project, Task or ProjectBrief) |
Globally unique identifier for object to fetch statuses from. Must be a GID for a project, project_brief, or task.
|
OverwriteFile |
Option |
Value |
True |
True |
False |
False |
|
SaveFolder |
Specify a disk folder path to save file(s) to
|
Fields |
Option |
Value |
name |
name |
resource_subtype |
resource_subtype |
connected_to_app |
connected_to_app |
created_at |
created_at |
download_url |
download_url |
host |
host |
parent |
parent |
parent.name |
parent.name |
parent.resource_subtype |
parent.resource_subtype |
permanent_url |
permanent_url |
size |
size |
view_url |
view_url |
|
[
Read more...
]
Parameter |
Description |
Workspace Id |
|
Owner Id |
|
[
Read more...
]
Parameter |
Description |
Workspace Id |
|
Project Id |
|
Portfolio Id |
|
Team Id |
|
Is Workspace Level |
Option |
Value |
true |
true |
false |
false |
|
Time Periods (e.g. Id1,Id2) |
|
Get Workspace Custom Fields
Get Project Custom Fields
Get Portfolio Custom Fields
[
Read more...
]
Parameter |
Description |
Project Id |
|
PortfolioId |
|
GoalId |
|
Member or Team Id (Use with Project OR Portfolio OR Goal) |
|
Get Time Tracking Entries
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...
]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Option |
Value |
No filter |
|
Example1 |
$.store.books[*] |
Example2 (Sections Under Books) |
$.store.books[*].sections[*] |
Example3 (Equals) |
$.store.books[?(@author=='sam')] |
Example4 (Equals - Any Section) |
$..[?(@author=='sam')] |
Example5 (Not Equals - Any Section) |
$..[?(@author!='sam')] |
Example6 (Number less than) |
$.store.books[?(@.price<10)]
Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] |
Example8 (Regular Expression - Does Not Contain Pattern) |
$.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] |
Example9 (Regular Expression - Exact Pattern Match) |
$.store.books[?(@author=~ /^sam|bob$/ )] |
Example10 (Regular Expression - Starts With) |
$.store.books[?(@author=~ /^sam/ )] |
Example11 (Regular Expression - Ends With) |
$.store.books[?(@author=~ /sam$/ )] |
Example12 (Between) |
$.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] |
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Generic Request (Bulk Write)
This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...
]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair
|
Asana Connector Examples for PowerShell Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys
API ODBC Driver
under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Read all workspaces
Read all projects
Read Tasks (default project)
[
Read more...
]
Read all tasks (default project)
Read Tasks for a specific project
[
Read more...
]
Read all tasks for a specified project
SELECT * FROM Tasks WITH (ProjectId='1200652735638082')
Read Sub Tasks - First Level (default project)
[
Read more...
]
Read all first level sub tasks for default project. If you sub tasks for 3rd, 4th level deep then this wont capture.
Read Sub Tasks - First Level for specified project
[
Read more...
]
Read all first level sub tasks for a specified project id. If you sub tasks for 3rd, 4th level deep then this wont capture.
SELECT * FROM SubTasks WITH (ProjectId='1200652735638082')
Read Sub Tasks for a specified parent task
[
Read more...
]
SELECT * FROM SubTasks WITH(QueryBy='task', TaskId='1207150838176996')
Read Workspace Tasks (All Projects)
[
Read more...
]
SELECT * FROM WorkspaceTasks
Search Tasks (Advanced Filters - Just like Asana Search UI)
[
Read more...
]
--//search text in task title or description
SELECT * FROM search_tasks WITH(Text='Hotfix')
--//search text in all tasks from any projects listed below
SELECT * FROM search_tasks WITH(Text='Hotfix', ProjectsAny='1200652735638082,1206028542305053')
--//list all tasks from any projects listed below
SELECT * FROM search_tasks WITH(Text='Hotfix', ProjectsAny='1200652735638082,1206028542305053')
--//list all tasks due on specified date (same way you can use CreatedOn, CompletedOn ...)
SELECT * FROM search_tasks WITH(DueOn='2024-12-21')
--//list all tasks with due date after specified date (same way you can use CreatedOnAfter, CompletedOnAfter ...)
SELECT * FROM search_tasks WITH(DueOnAfter='2024-12-21')
SELECT * FROM search_tasks WITH(DueOnAfter='yearstart+1d')
--//list all tasks with due date after specified date (same way you can use CreatedOnBefore, CompletedOnBefore ...)
SELECT * FROM search_tasks WITH(DueOnBefore='2024-12-21')
SELECT * FROM search_tasks WITH(DueOnBefore='monthstart-5d')
--//list all tasks with due date after specified datetime (same way you can use CreatedAtBefore, CompletedAtBefore ...)
SELECT * FROM search_tasks WITH(DueAtBefore='2024-12-21T23:59:59')
SELECT * FROM search_tasks WITH(DueAtBefore='now-10h')
--//list all tasks with attachment
SELECT * FROM search_tasks WITH(HasAttachment='true')
Download Attachment to Local Disk
[
Read more...
]
Download Attachment to Local Disk File.
SELECT * FROM download_attachment
WITH (
AttachmentId='1208216218258030'
, TargetFilePath='c:\temp\1208216218258030_AWS-refund-request.png'
, FileOverwriteMode=0 --0=AlwaysOverwrite, 1=FailIfExists, 2=SkipIfExists
)
Download Multiple Attachments to Local Disk
[
Read more...
]
Download Multiple Attachments for a specified Parent (e.g. Task, Project, ProjectBrief) to Local Disk Folder. Saved file name syntax is {AttachmentId}_{FileName}.
SELECT * FROM download_attachments
WITH (
ParentId='1206673375982078' --Id of Task , Project or ProjectBrief
, SaveFolder='c:\temp'
, OverwriteFile=1
)
Read Portfolios for a specified Owner
[
Read more...
]
Read Portfolios for a specified Owner (Default Workspace).
SELECT * FROM Portfolios WITH(OwnerId='1200442904128317')
Read Portfolios for a specified Owner and Workspace
[
Read more...
]
Read Portfolios for a specified Owner Id and Workspace id.
SELECT * FROM Portfolios WITH(OwnerId='1200442904128317', WorkspaceId='1200442900140748')
Read Goals for a specified Project Id.
SELECT * FROM Goals WITH(Project='1206673375982078')
Read Workspace Goals
[
Read more...
]
Read Goals for a specified Workspace Id.
SELECT * FROM Goals WITH(Workspace='1200442900140748')
Read Goals for a specified Team Id.
SELECT * FROM Goals WITH(Team='1200442900140748')
Read Memberships for a project
[
Read more...
]
Read Memberships for a specific project.
SELECT * FROM Memberships WITH(ProjectId=1206673375982078)
Read Memberships for a project
[
Read more...
]
Read Memberships for a specific project.
SELECT * FROM Memberships WITH(PortfolioId=1206673375982077)
Read Time Entries for a Task
[
Read more...
]
Read Time Entries for a specific task.
SELECT * FROM TimeTrackingEntries WITH(TaskId=1207150837043133)
Conclusion
In this article we showed you how to connect to Asana in PowerShell and integrate data without any coding, saving you time and effort.
We encourage you to download Asana Connector for PowerShell and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team.
You can also open a live chat immediately by clicking on the chat icon below.
Download Asana Connector for PowerShell
Documentation
More integrations
Other connectors for PowerShell
Other application integration scenarios for Asana
Common Searches:
How to connect Asana in PowerShell?
How to get Asana data in PowerShell?
How to read Asana data in PowerShell?
How to load Asana data in PowerShell?
How to import Asana data in PowerShell?
How to pull Asana data in PowerShell?
How to push data to Asana in PowerShell?
How to write data to Asana in PowerShell?
How to POST data to Asana in PowerShell?
Call Asana API in PowerShell
Consume Asana API in PowerShell
Asana PowerShell Automate
Asana PowerShell Integration
Integration Asana in PowerShell
Consume real-time Asana data in PowerShell
Consume real-time Asana API data in PowerShell
Asana ODBC Driver | ODBC Driver for Asana | ODBC Asana Driver | SSIS Asana Source | SSIS Asana Destination
Connect Asana in PowerShell
Load Asana in PowerShell
Load Asana data in PowerShell
Read Asana data in PowerShell
Asana API Call in PowerShell