Asana Component

Manage users, projects, and teams in your Asana workspace
Component key: asana#
DescriptionAsana is a web and mobile application designed to help teams organize, track, and manage their work.
Use the Asana component to manage users, projects, and teams in your Asana workspace
#
Asana Connections#
Asana API KeyBefore you create the connection, you must first generate a Personal Access Token from the Asana developer console. See the Authentication Quick Start for detailed instructions on getting started with PATs.
For more information refer to the Asana Docs
Create a new connection of type API Key.
- For API Key use the value you received from the Asana developer console.
Input | Notes | Example |
---|---|---|
Input API Key string / Required | Notes Provide a valid API Key from your Asana Developer Portal | Example example97023fhn852103/4236523535 |
#
Asana OAuth 2.0 ConnectionBefore you can create the connection, you must first register your application with Asana to receive a client ID and client secret. You can do so by visiting the Account Settings, then click the Apps tab, and "Add New Application". Remember to configure your app to use the Prismatic Redirect URL.
For more information refer to the Asana Docs
Create a new connection of type OAuth 2.0 - Authorization Code.
- For Client ID and Client Secret enter the values that you got from the Asana developer console.
- For Scopes enter 'default'
Input | Default | Notes |
---|---|---|
Input Authorize URL string / Required Hidden Field | Default https://app.asana.com/-/oauth_authorize | Notes The OAuth 2.0 Authorization URL for Asana |
Input Client ID string / Required | Default | Notes Get started at https://asana.com/developers |
Input Client Secret password / Required | Default | Notes Get started at https://asana.com/developers |
Input Scopes string | Default | Notes A space-delimited set of one or more scopes to get the user's permission to access. Defaults to the default OAuth scope if no scopes are specified. |
Input Token URL string / Required Hidden Field | Default https://app.asana.com/-/oauth_token | Notes The OAuth 2.0 Token URL for Asana |
#
Actions#
Add Custom Field To PortfolioAdd a custom field to an existing portfolio | key: addCustomField
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Insert After string | Notes Provide a value for the insert after. | Example 843750385 |
Input Insert before string | Notes Provide a value for insert before. | Example 843750385 |
Input Is Important string / Required | Notes Determines if the custom field will be marked as important | Example 843750385 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Add Custom Field To ProjectAdd a new Custom Field to an existing Project | key: addCustomFieldToProject
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Insert After string | Notes Provide a value for the insert after. | Example 843750385 |
Input Insert before string | Notes Provide a value for insert before. | Example 843750385 |
Input Is Important string / Required | Notes Determines if the custom field will be marked as important | Example 843750385 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
#
Add Followers To TaskAdd followers to an existing task | key: addFollowersToTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Followers List string Value List | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Add Tag To TaskAdd a tag to an existing task | key: addTagToTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Tag Id string / Required | Notes Provide the unique identifier of the tag. | Example 843750385 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Add Task To SectionAdd an existing task to the given section of a project | key: addTaskToSection
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Insert After string | Notes Provide a value for the insert after. | Example 843750385 |
Input Insert before string | Notes Provide a value for insert before. | Example 843750385 |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
#
Add User To PortfolioAdd an existing user to the given portfolio | key: addUserToPortfolio
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Members string / Required | Notes Provide a comma separated list of user Ids | Example 1234,1234 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Add User To TeamAdd an existing user to the given team | key: addUserToTeam
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Team Id string / Required | Notes Provide the unique identifier of the team. | Example 843750385 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
#
Add User To WorkspaceAdd a new user to the given workspace | key: addUser
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Add Users To ProjectAdd an existing user to the given project | key: addUserToProject
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Members string / Required | Notes Provide a comma separated list of user Ids | Example 843750385,843750385 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
#
Create Custom FieldCreate a new custom field record | key: createCustomField
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a value for the description. | Example This is an example description. |
Input Enabled boolean | Default false | Notes Determines if the custom field is enabled. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Number Value string | Default | Notes Provide a number value for the custom field. | Example 5.2 |
Input Resource Subtype string | Default | Notes Provide a string value for the type of object. | Example task |
Input Text Value string | Default | Notes Provide a text value for the custom field | Example 2 |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Create PortfolioCreate a new portfolio | key: createPortfolio
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Color string / Required | Default | Notes Provide a value for the color of the object. | Example light-green |
Input Public boolean / Required | Default false | Notes True if the object is public to its team. | Example |
Input Members string Value List | Default | Notes For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user. | Example light-green |
Input Portfolio Name string / Required | Default | Notes Give a name to the portfolio | Example My Portfolio |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Create Project In TeamCreate a new project inside of an existing team or organization | key: createProjects
Input | Default | Notes | Example |
---|---|---|---|
Input Archived boolean | Default false | Notes True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Author string | Default | Notes Provide a string value for the name of the author. You can also provide the unique identifier of a user who belongs to the same organization/workspace. | Example John Doe |
Input Created By string | Default | Notes This name represents an account in Asana that created the object. You can also provide a user Id or email. | Example John Doe |
Input Default View string | Default | Notes The default view of the project. | Example |
Input Due On string | Default | Notes The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at. | Example 2019-09-15 |
Input Followers string | Default | Notes Provide a comma separated string of users. | Example 8570756435,375893453 |
Input Public boolean / Required | Default false | Notes True if the object is public to its team. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Default | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Owner Id string / Required | Default | Notes Provide the unique identifier of the owner of the project. | Example 375893453 |
Input Project Color string | Default | Notes Provide the default color for your project. | Example light-green |
Input Start On string | Default | Notes The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format | Example 2021-11-14 |
Input Status Update Color string / Required | Default | Notes The color associated with the status update. | Example green |
Input Status Update Text string / Required | Default | Notes The text content of the status update. | Example The project is moving forward according to plan. |
Input Status Update Title string / Required | Default | Notes The title of the project status update. | Example Example Status Update - Jun 15 |
Input Team string | Default | Notes The team that this project is shared with. This field only exists for projects in organizations. Including this field if you do not meet those conditions could cause your request to fail. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "89754368332", "archived": false, "color": "light-green", "custom_fields": {}, "default_view": "calendar", "followers": [ { "guid": "487535349", "name": "Example User", "resource_type": "user" } ], "is_template": false, "members": [ { "guid": "394375092234", "name": "Example User", "resource_type": "user" } ], "name": "MyProject", "notes": "These are my project notes!", "owner": { "guid": "432934564345", "name": "Example User", "resource_type": "user" }, "public": true } ]}
#
Create Project In WorkspaceCreate a new project inside of an existing workspace | key: createProjectsInWorkspace
Input | Default | Notes | Example |
---|---|---|---|
Input Archived boolean | Default false | Notes True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Author string | Default | Notes Provide a string value for the name of the author. You can also provide the unique identifier of a user who belongs to the same organization/workspace. | Example John Doe |
Input Created By string | Default | Notes This name represents an account in Asana that created the object. You can also provide a user Id or email. | Example John Doe |
Input Default View string | Default | Notes The default view of the project. | Example |
Input Due On string | Default | Notes The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at. | Example 2019-09-15 |
Input Followers string | Default | Notes Provide a comma separated string of users. | Example 8570756435,375893453 |
Input Public boolean / Required | Default false | Notes True if the object is public to its team. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Default | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Owner Id string / Required | Default | Notes Provide the unique identifier of the owner of the project. | Example 375893453 |
Input Project Color string | Default | Notes Provide the default color for your project. | Example light-green |
Input Start On string | Default | Notes The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format | Example 2021-11-14 |
Input Status Update Color string / Required | Default | Notes The color associated with the status update. | Example green |
Input Status Update Text string / Required | Default | Notes The text content of the status update. | Example The project is moving forward according to plan. |
Input Status Update Title string / Required | Default | Notes The title of the project status update. | Example Example Status Update - Jun 15 |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "89754368332", "archived": false, "color": "light-green", "custom_fields": {}, "default_view": "calendar", "followers": [ { "guid": "487535349", "name": "Example User", "resource_type": "user" } ], "is_template": false, "members": [ { "guid": "394375092234", "name": "Example User", "resource_type": "user" } ], "name": "MyProject", "notes": "These are my project notes!", "owner": { "guid": "432934564345", "name": "Example User", "resource_type": "user" }, "public": true } ]}
#
Create SectionCreate a new section of a project | key: createSection
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Connection connection / Required | Notes | Example |
Input Insert After string | Notes Provide a value for the insert after. | Example 843750385 |
Input Insert before string | Notes Provide a value for insert before. | Example 843750385 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
Input Section Name string / Required | Notes Provide a value for the name of the section | Example 843750385 |
#
Create TagCreate a new tag | key: createTag
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Color string / Required | Notes Provide a value for the color of the object. | Example light-green |
Input Followers List string Value List | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Name string | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Create TaskCreate a new task inside a workspace or organization | key: createTask
Input | Default | Notes | Example |
---|---|---|---|
Input Approval Status string / Required | Default | Notes Provide a string value for the approval status of the task. | Example Pending |
Input Connection connection / Required | Default | Notes | Example |
Input Assignee Id string / Required | Default | Notes Provide the unique identifier of the assignee. | Example 843750385 |
Input Assignee Section Id string | Default | Notes Provide the unique identifier of the section to assign the task to. The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list. | Example 843750385 |
Input Assignee Status string | Default | Notes Provide a string value representing the status the task has in relation to its assignee. This field is deprecated, you can still use it to form requests but it is not recommended for creating new records. | Example upcoming |
Input Completed By string | Default | Notes Provide a string value for the name of the user who completed the task. You can also provide a userId, or email. | Example John Doe |
Input Due At string | Default | Notes Provide an ISO 8601 date string in UTC and should NOT be used together with Due On. | Example 2019-09-15T02:06:58.147Z |
Input Due On string | Default | Notes The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at. | Example 2019-09-15 |
Input Followers List string Value List | Default | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Completed boolean | Default false | Notes True if the project is completed, false if not. This properties value is configured conditionally on the value of the Approval Status property. | Example |
Input Is Liked boolean | Default false | Notes This flag will mark the specified task as 'liked' in your Asana account. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Default | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Parent Id string | Default | Notes Provide the unique identifier of the parent element. | Example 843750385 |
Input Project List string Value List | Default | Notes For each item, provide the unique identifier of the project. | Example 843750385 |
Input Resource Subtype string | Default | Notes Provide a string value for the type of object. | Example task |
Input Start On string | Default | Notes The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format | Example 2021-11-14 |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
Every task is required to be created in a specific workspace, and this workspace cannot be changed once set. The workspace need not be set explicitly if you specify projects or a parent task instead.
For more information refer to the Asana Docs
#
Output Example Payload{ "data": { "guid": "75834703724", "projects": "", "resource_type": "task", "name": "MyTask", "notes": "These are my example task notes!", "completed": false, "resource_subtype": "default_task", "tags": "", "workspace": { "guid": "867452364563", "resource_type": "workspace", "name": "Example Workspace" }, "custom_fields": {}, "assignee": { "guid": "32493284234", "name": "Example Assignee", "resource_type": "user" }, "parent": null, "assignee_status": "inbox", "hearted": false }}
#
Create TeamCreate a new team | key: createTeam
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Organization Id string / Required | Notes Provide the unique identifier of the organization. | Example 375893453 |
Input Description string | Notes Provide a string value for the description of the team. | Example This is an example description |
Input Name string / Required | Notes Provide a string value for the name of the team. | Example Engineering Team |
#
Delete AttachmentDelete an existing attachment | key: deleteAttachment
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Attachment Id string / Required | Notes Provide an id for the given attachment | Example 843750385 |
#
Delete Custom FieldDelete the information and metadata of a custom field | key: deleteCustomField
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Delete PortfolioDelete the information and metadata of a portfolio | key: deletePortfolio
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Delete ProjectDelete the information and metadata of a project by Id | key: deleteProjects
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
#
Output Example Payload{ "data": {}}
#
Delete SectionDelete the information and metadata of a section | key: deleteSection
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
#
Delete TagDelete the information and metadata of the given tag | key: deleteTag
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Tag Id string / Required | Notes Provide the unique identifier of the tag. | Example 843750385 |
#
Delete TaskDelete the information and metadata of an existing task | key: deleteTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Get AttachmentsGet the information and metadata of an attachment | key: getAttachment
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Attachment Id string / Required | Notes Provide an id for the given attachment | Example 843750385 |
#
Get Custom FieldGet the information and metadata of a custom field | key: getCustomField
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Get PortfolioGet the information and metadata of a portfolio | key: getPortfolio
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Get Portfolio ItemGet the information and metadata of a portfolio item | key: getPortfolioItem
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Item Id string / Required | Notes Provide the unique identifier of the Item. | Example 843750385 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Get ProjectGet the information and metadata of a project by Id | key: getProject
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "89754368332", "archived": false, "color": "light-green", "custom_fields": {}, "default_view": "calendar", "followers": [ { "guid": "487535349", "name": "Example User", "resource_type": "user" } ], "is_template": false, "members": [ { "guid": "394375092234", "name": "Example User", "resource_type": "user" } ], "name": "MyProject", "notes": "These are my project notes!", "owner": { "guid": "432934564345", "name": "Example User", "resource_type": "user" }, "public": true } ]}
#
Get SectionGet the information and metadata of a section | key: getSection
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
#
Get TagGet the information and metadata of the given tag | key: getTag
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Tag Id string / Required | Notes Provide the unique identifier of the tag. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Get TaskGet the information and metadata of a task | key: getTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": { "guid": "75834703724", "projects": "", "resource_type": "task", "name": "MyTask", "notes": "These are my example task notes!", "completed": false, "resource_subtype": "default_task", "tags": "", "workspace": { "guid": "867452364563", "resource_type": "workspace", "name": "Example Workspace" }, "custom_fields": {}, "assignee": { "guid": "32493284234", "name": "Example Assignee", "resource_type": "user" }, "parent": null, "assignee_status": "inbox", "hearted": false }}
#
Get TeamGet the information and metadata of a team | key: getTeam
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Team Id string / Required | Notes Provide the unique identifier of the team. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": { "guid": "4353535343", "name": "Example Team", "organization": { "guid": "485983543", "name": "Example Organization", "resource_type": "workspace" } }}
#
Get UserGet the information and metadata of a user | key: getUsers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
#
Output Example Payload{ "data": { "guid": "57034734553", "email": "someone@example.prismatic.io", "name": "Example User", "photo": null, "resource_type": "user", "workspaces": [ { "guid": "947603953453", "name": "Example Workspace", "resource_type": "workspace" } ] }}
#
Get WorkspaceGet the information and metadata of the given Workspace | key: getWorkspace
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
List attachmentsList all attachments in a given task | key: listAttachments
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
#
List Custom FieldList all custom fields in your account | key: listCustomFields
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
List Portfolio ItemsList all items in a given portfolio | key: listPortfolioItems
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
List PortfoliosList all portfolios in your account | key: listPortfolios
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Owner Id string / Required | Notes Provide the unique identifier of the owner of the project. | Example 375893453 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
List ProjectsReturn a list of all projects connected to your account | key: listProjects
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Workspace Id string | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "0e750873053", "name": "ExampleProjectName", "resource_type": "project" }, { "guid": "0e750873053", "name": "ExampleProjectName", "resource_type": "project" }, { "guid": "0e750873053", "name": "ExampleProjectName", "resource_type": "project" } ]}
#
List SectionsList all sections of the given project | key: listSections
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
Input Workspace Id string | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
List SubtasksReturn a list of all subtasks in a given task | key: listSubtasks
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Assignee Id string / Required | Notes Provide the unique identifier of the assignee. | Example 843750385 |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "458738457453", "name": "Example Task", "resource_type": "task" }, { "guid": "458738457453", "name": "Example Task", "resource_type": "task" }, { "guid": "458738457453", "name": "Example Task", "resource_type": "task" } ]}
#
List TagsList all tags in your account | key: listTags
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
List Tags In TaskList all tags in a given task | key: listTagsInTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
#
List TasksReturn a list of all the tasks in your account | key: listTasks
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Assignee Id string / Required | Notes Provide the unique identifier of the assignee. | Example 843750385 |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "458738457453", "name": "Example Task", "resource_type": "task" }, { "guid": "458738457453", "name": "Example Task", "resource_type": "task" }, { "guid": "458738457453", "name": "Example Task", "resource_type": "task" } ]}
#
List TeamsList all teams in the given workspace | key: listTeams
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": { "guid": "4353535343", "name": "Example Team", "organization": { "guid": "485983543", "name": "Example Organization", "resource_type": "workspace" } }}
#
List Users In WorkspaceList all users in the given workspace | key: listUsers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Limit string | Notes Provide an integer value for the item limit per page. | Example 20 |
Input Offset string | Notes Provide a value for the pagination token offset. | Example 20 |
Input Workspace Id string | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "54630745323", "name": "Example User", "resource_type": "user" }, { "guid": "54630745323", "name": "Example User", "resource_type": "user" }, { "guid": "54630745323", "name": "Example User", "resource_type": "user" } ]}
#
List WorkspacesList of all workspaces connected to your account | key: listWorkspaces
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Remove Custom Field From ProjectRemove an existing Custom Field from an existing Project | key: removeCustomFieldFromProject
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
#
Remove Follower From TaskRemove a follower from the given task | key: removeFollowersFromTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Followers List string Value List | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Remove Portfolio ItemRemove an existing item from the given portfolio | key: removePortfolioItem
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Item Id string / Required | Notes Provide the unique identifier of the Item. | Example 843750385 |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Remove Tag From TaskRemove a tag from the given task | key: removeTagFromTask
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Tag Id string / Required | Notes Provide the unique identifier of the tag. | Example 843750385 |
Input Task Id string / Required | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Remove User From PortfolioRemove an existing user from the given portfolio | key: removeUserFromPortfolio
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Portfolio Id string / Required | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
#
Update Custom FieldUpdate the information and metadata of an existing custom field | key: updateCustomField
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a value for the description. | Example This is an example description. |
Input Enabled boolean | Default false | Notes Determines if the custom field is enabled. | Example |
Input Field Id string / Required | Default | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Number Value string | Default | Notes Provide a number value for the custom field. | Example 5.2 |
Input Resource Subtype string | Default | Notes Provide a string value for the type of object. | Example task |
Input Text Value string | Default | Notes Provide a text value for the custom field | Example 2 |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Update PortfolioUpdate the information and metadata of the given portfolio | key: updatePortfolio
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Color string / Required | Default | Notes Provide a value for the color of the object. | Example light-green |
Input Public boolean / Required | Default false | Notes True if the object is public to its team. | Example |
Input Members string Value List | Default | Notes For each value, provide the user id of a member. These can either be the string 'me', an email, or the gid of a user. | Example light-green |
Input Portfolio Id string / Required | Default | Notes Provide the unique identifier of the portfolio. | Example 843750385 |
Input Portfolio Name string / Required | Default | Notes Give a name to the portfolio | Example My Portfolio |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Update ProjectUpdate the information and metadata of a project | key: updateProject
Input | Default | Notes | Example |
---|---|---|---|
Input Archived boolean | Default false | Notes True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Author string | Default | Notes Provide a string value for the name of the author. You can also provide the unique identifier of a user who belongs to the same organization/workspace. | Example John Doe |
Input Created By string | Default | Notes This name represents an account in Asana that created the object. You can also provide a user Id or email. | Example John Doe |
Input Default View string | Default | Notes The default view of the project. | Example |
Input Due On string | Default | Notes The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at. | Example 2019-09-15 |
Input Followers string | Default | Notes Provide a comma separated string of users. | Example 8570756435,375893453 |
Input Public boolean / Required | Default false | Notes True if the object is public to its team. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Default | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Owner Id string | Default | Notes Provide the unique identifier of the owner of the project. | Example 375893453 |
Input Project Color string | Default | Notes Provide the default color for your project. | Example light-green |
Input Project Id string / Required | Default | Notes Provide the unique identifier of the project. | Example 375893453 |
Input Start On string | Default | Notes The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format | Example 2021-11-14 |
Input Status Update Color string / Required | Default | Notes The color associated with the status update. | Example green |
Input Status Update Text string / Required | Default | Notes The text content of the status update. | Example The project is moving forward according to plan. |
Input Status Update Title string / Required | Default | Notes The title of the project status update. | Example Example Status Update - Jun 15 |
Input Team string | Default | Notes The team that this project is shared with. This field only exists for projects in organizations. Including this field if you do not meet those conditions could cause your request to fail. | Example 375893453 |
#
Output Example Payload{ "data": [ { "guid": "89754368332", "archived": false, "color": "light-green", "custom_fields": {}, "default_view": "calendar", "followers": [ { "guid": "487535349", "name": "Example User", "resource_type": "user" } ], "is_template": false, "members": [ { "guid": "394375092234", "name": "Example User", "resource_type": "user" } ], "name": "MyProject", "notes": "These are my project notes!", "owner": { "guid": "432934564345", "name": "Example User", "resource_type": "user" }, "public": true } ]}
#
Update SectionUpdate the information and metadata of a project section | key: updateSection
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Insert After string | Notes Provide a value for the insert after. | Example 843750385 |
Input Insert before string | Notes Provide a value for insert before. | Example 843750385 |
Input Project Id string / Required | Notes Provide the unique identifier of the project. | Example 375893453 |
Input Field Id string / Required | Notes Provide the unique identifier of the field. | Example 843750385 |
Input Section Name string / Required | Notes Provide a value for the name of the section | Example 843750385 |
#
Update TagUpdate the information and metadata of the given tag | key: updateTag
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Color string / Required | Notes Provide a value for the color of the object. | Example light-green |
Input Followers List string Value List | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Name string | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Tag Id string / Required | Notes Provide the unique identifier of the tag. | Example 843750385 |
Input Workspace Id string / Required | Notes Provide a unique identifier for the workspace. | Example 375893453 |
#
Update TaskUpdate the information and metadata of the given task | key: updateTask
Input | Default | Notes | Example |
---|---|---|---|
Input Approval Status string | Default | Notes Provide a string value for the approval status of the task. | Example Pending |
Input Connection connection / Required | Default | Notes | Example |
Input Assignee Id string | Default | Notes Provide the unique identifier of the assignee. | Example 843750385 |
Input Assignee Section Id string | Default | Notes Provide the unique identifier of the section to assign the task to. The assignee section is a subdivision of a project that groups tasks together in the assignee's 'My Tasks' list. | Example 843750385 |
Input Assignee Status string | Default | Notes Provide a string value representing the status the task has in relation to its assignee. This field is deprecated, you can still use it to form requests but it is not recommended for creating new records. | Example upcoming |
Input Completed By string | Default | Notes Provide a string value for the name of the user who completed the task. You can also provide a userId, or email. | Example John Doe |
Input Due At string | Default | Notes Provide an ISO 8601 date string in UTC and should NOT be used together with Due On. | Example 2019-09-15T02:06:58.147Z |
Input Due On string | Default | Notes The date in which the project is due. This field takes a date with YYYY-MM-DD format and should not be used together with due_at. | Example 2019-09-15 |
Input Followers List string Value List | Default | Notes For each item, provide the unique identifier of an existing userId. | Example 843750385 |
Input Completed boolean | Default false | Notes True if the project is completed, false if not. This properties value is configured conditionally on the value of the Approval Status property. | Example |
Input Is Liked boolean | Default false | Notes This flag will mark the specified task as 'liked' in your Asana account. | Example |
Input Name string | Default | Notes Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. | Example Example - Populate customers page with live data |
Input Notes text | Default | Notes Free-form textual information associated with the object (ie., its description). | Example These are some example notes. |
Input Parent Id string | Default | Notes Provide the unique identifier of the parent element. | Example 843750385 |
Input Project List string Value List | Default | Notes For each item, provide the unique identifier of the project. | Example 843750385 |
Input Resource Subtype string | Default | Notes Provide a string value for the type of object. | Example task |
Input Start On string | Default | Notes The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format | Example 2021-11-14 |
Input Task Id string / Required | Default | Notes Provide the unique identifier for the task. | Example 375893453 |
Input User Id string / Required | Default | Notes Provide a unique identifier for the user | Example 375893453 |
Input Workspace Id string | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
Input Workspace Id string / Required | Default | Notes Provide a unique identifier for the workspace. | Example 375893453 |
Completed by, approval status, and isCompleted cannot be updated in the same request. If you attempt do do this you will likely receive a 400 back from Asana.
#
Output Example Payload{ "data": { "guid": "75834703724", "projects": "", "resource_type": "task", "name": "MyTask", "notes": "These are my example task notes!", "completed": false, "resource_subtype": "default_task", "tags": "", "workspace": { "guid": "867452364563", "resource_type": "workspace", "name": "Example Workspace" }, "custom_fields": {}, "assignee": { "guid": "32493284234", "name": "Example Assignee", "resource_type": "user" }, "parent": null, "assignee_status": "inbox", "hearted": false }}