Turn Asana project tasks into a grounded status update, then manage only the changes you review.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Prepare a project status update
Ask me to choose an Asana project and read one page of its tasks. Prepare a status update with task names and IDs, owners, due dates and completion status where returned. Highlight missing owners and overdue work only when the response supports it. Preserve task links, flag any additional page and do not change assignments.
Explore this command: asana.gettasksforproject
Prepare a task handoff
Ask me for an Asana task GID. Read that task and turn its returned description, ownership, dates and status into a concise handoff with open questions. Keep the original task ID and link. Do not claim that comments, subtasks or attachments were read unless they are included in the response.
Explore this command: asana.gettask
What you can do (269)
What you can do
Available commands: 269 (127 read, 142 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Get access requests — asana.getaccessrequests |
Read |
Create an access request — asana.createaccessrequest |
Write |
Approve an access request — asana.approveaccessrequest |
Write |
Reject an access request — asana.rejectaccessrequest |
Write |
Get a list of agents in a workspace — asana.getagentsforworkspace |
Read |
Get an agent — asana.getagent |
Read |
Get AI Studio credit utilization — asana.getaistudioruns |
Read |
Get AI Studio seats — asana.getaistudioseats |
Read |
Get an allocation — asana.getallocation |
Read |
Update an allocation — asana.updateallocation |
Write |
Delete an allocation — asana.deleteallocation |
Write |
Get multiple allocations — asana.getallocations |
Read |
Create an allocation — asana.createallocation |
Write |
Get an attachment — asana.getattachment |
Read |
Delete an attachment — asana.deleteattachment |
Write |
Get attachments from an object — asana.getattachmentsforobject |
Read |
Get audit log events — asana.getauditlogevents |
Read |
Submit parallel requests — asana.createbatchrequest |
Write |
Get all budgets — asana.getbudgets |
Read |
Create a budget — asana.createbudget |
Write |
Get a budget — asana.getbudget |
Read |
Update a budget — asana.updatebudget |
Write |
Delete a budget — asana.deletebudget |
Write |
Get a project's custom fields — asana.getcustomfieldsettingsforproject |
Read |
Get a portfolio's custom fields — asana.getcustomfieldsettingsforportfolio |
Read |
Get a goal's custom fields — asana.getcustomfieldsettingsforgoal |
Read |
Get a team's custom fields — asana.getcustomfieldsettingsforteam |
Read |
Create a custom field — asana.createcustomfield |
Write |
Get a custom field — asana.getcustomfield |
Read |
Update a custom field — asana.updatecustomfield |
Write |
Delete a custom field — asana.deletecustomfield |
Write |
Get a workspace's custom fields — asana.getcustomfieldsforworkspace |
Read |
Create an enum option — asana.createenumoptionforcustomfield |
Write |
Reorder a custom field's enum — asana.insertenumoptionforcustomfield |
Write |
Update an enum option — asana.updateenumoption |
Write |
Get all custom types associated with an object — asana.getcustomtypes |
Read |
Get a custom type — asana.getcustomtype |
Read |
Get events on a resource — asana.getevents |
Read |
Initiate a graph export — asana.creategraphexport |
Write |
Initiate a resource export — asana.createresourceexport |
Write |
Get a goal relationship — asana.getgoalrelationship |
Read |
Update a goal relationship — asana.updategoalrelationship |
Write |
Get goal relationships — asana.getgoalrelationships |
Read |
Add a supporting goal relationship — asana.addsupportingrelationship |
Write |
Removes a supporting goal relationship — asana.removesupportingrelationship |
Write |
Get a goal — asana.getgoal |
Read |
Update a goal — asana.updategoal |
Write |
Delete a goal — asana.deletegoal |
Write |
Get goals — asana.getgoals |
Read |
Create a goal — asana.creategoal |
Write |
Create a goal metric — asana.creategoalmetric |
Write |
Update a goal metric — asana.updategoalmetric |
Write |
Add a collaborator to a goal — asana.addfollowers |
Write |
Remove a collaborator from a goal — asana.removefollowers |
Write |
Get parent goals from a goal — asana.getparentgoalsforgoal |
Read |
Add a custom field to a goal — asana.addcustomfieldsettingforgoal |
Write |
Remove a custom field from a goal — asana.removecustomfieldsettingforgoal |
Write |
Get a job by id — asana.getjob |
Read |
Get multiple memberships — asana.getmemberships |
Read |
Create a membership — asana.createmembership |
Write |
Get a membership — asana.getmembership |
Read |
Update a membership — asana.updatemembership |
Write |
Delete a membership — asana.deletemembership |
Write |
Get notifications for a user — asana.getnotificationsforuser |
Read |
Mark notifications as read — asana.marknotificationsreadforuser |
Write |
Mark notifications as unread — asana.marknotificationsunreadforuser |
Write |
Get an OOO entry — asana.getoooentry |
Read |
Update an OOO entry — asana.updateoooentry |
Write |
Delete an OOO entry — asana.deleteoooentry |
Write |
Get OOO entries for a user — asana.getoooentries |
Read |
Create an OOO entry — asana.createoooentry |
Write |
Create an organization export request — asana.createorganizationexport |
Write |
Get details on an org export request — asana.getorganizationexport |
Read |
Get multiple portfolio memberships — asana.getportfoliomemberships |
Read |
Get a portfolio membership — asana.getportfoliomembership |
Read |
Get memberships from a portfolio — asana.getportfoliomembershipsforportfolio |
Read |
Get multiple portfolios — asana.getportfolios |
Read |
Create a portfolio — asana.createportfolio |
Write |
Get a portfolio — asana.getportfolio |
Read |
Update a portfolio — asana.updateportfolio |
Write |
Delete a portfolio — asana.deleteportfolio |
Write |
Get portfolio items — asana.getitemsforportfolio |
Read |
Add a portfolio item — asana.additemforportfolio |
Write |
Remove a portfolio item — asana.removeitemforportfolio |
Write |
Add a custom field to a portfolio — asana.addcustomfieldsettingforportfolio |
Write |
Remove a custom field from a portfolio — asana.removecustomfieldsettingforportfolio |
Write |
Add users to a portfolio — asana.addmembersforportfolio |
Write |
Remove users from a portfolio — asana.removemembersforportfolio |
Write |
Duplicate a portfolio — asana.duplicateportfolio |
Write |
Get a project brief — asana.getprojectbrief |
Read |
Update a project brief — asana.updateprojectbrief |
Write |
Delete a project brief — asana.deleteprojectbrief |
Write |
Create a project brief — asana.createprojectbrief |
Write |
Get a project membership — asana.getprojectmembership |
Read |
Get memberships from a project — asana.getprojectmembershipsforproject |
Read |
Get a project portfolio setting — asana.getprojectportfoliosetting |
Read |
Update a project portfolio setting — asana.updateprojectportfoliosetting |
Write |
Get project portfolio settings for a project — asana.getprojectportfoliosettingsforproject |
Read |
Get project portfolio settings for a portfolio — asana.getprojectportfoliosettingsforportfolio |
Read |
Get a project status — asana.getprojectstatus |
Read |
Delete a project status — asana.deleteprojectstatus |
Write |
Get statuses from a project — asana.getprojectstatusesforproject |
Read |
Create a project status — asana.createprojectstatusforproject |
Write |
Get a project template — asana.getprojecttemplate |
Read |
Delete a project template — asana.deleteprojecttemplate |
Write |
Get multiple project templates — asana.getprojecttemplates |
Read |
Get a team's project templates — asana.getprojecttemplatesforteam |
Read |
Instantiate a project from a project template — asana.instantiateproject |
Write |
Get multiple projects — asana.getprojects |
Read |
Create a project — asana.createproject |
Write |
Get a project — asana.getproject |
Read |
Update a project — asana.updateproject |
Write |
Delete a project — asana.deleteproject |
Write |
Duplicate a project — asana.duplicateproject |
Write |
Get projects a task is in — asana.getprojectsfortask |
Read |
Get a team's projects — asana.getprojectsforteam |
Read |
Create a project in a team — asana.createprojectforteam |
Write |
Get all projects in a workspace — asana.getprojectsforworkspace |
Read |
Create a project in a workspace — asana.createprojectforworkspace |
Write |
Search projects in a workspace — asana.searchprojectsforworkspace |
Read |
Add a custom field to a project — asana.addcustomfieldsettingforproject |
Write |
Remove a custom field from a project — asana.removecustomfieldsettingforproject |
Write |
Get task count of a project — asana.gettaskcountsforproject |
Read |
Add users to a project — asana.addmembersforproject |
Write |
Remove users from a project — asana.removemembersforproject |
Write |
Add followers to a project — asana.addfollowersforproject |
Write |
Remove followers from a project — asana.removefollowersforproject |
Write |
Create a project template from a project — asana.projectsaveastemplate |
Write |
Roll up subtask dates for a project — asana.rollupproject |
Write |
Get multiple rates — asana.getrates |
Read |
Create a rate — asana.createrate |
Write |
Get a rate — asana.getrate |
Read |
Update a rate — asana.updaterate |
Write |
Delete a rate — asana.deleterate |
Write |
Get reactions with an emoji base on an object. — asana.getreactionsonobject |
Read |
Get records in a table — asana.getrecordsfortable |
Read |
Search records in a workspace — asana.searchrecordsforworkspace |
Read |
Create a record — asana.createrecord |
Write |
Get a record — asana.getrecord |
Read |
Update a record — asana.updaterecord |
Write |
Delete a record — asana.deleterecord |
Write |
Get multiple roles — asana.getroles |
Read |
Create a role — asana.createrole |
Write |
Get a role — asana.getrole |
Read |
Update a role — asana.updaterole |
Write |
Delete a role — asana.deleterole |
Write |
Trigger a rule — asana.triggerrule |
Write |
Get a section — asana.getsection |
Read |
Update a section — asana.updatesection |
Write |
Delete a section — asana.deletesection |
Write |
Get sections in a project — asana.getsectionsforproject |
Read |
Create a section in a project — asana.createsectionforproject |
Write |
Add task to section — asana.addtaskforsection |
Write |
Move or Insert sections — asana.insertsectionforproject |
Write |
Get a status update — asana.getstatus |
Read |
Delete a status update — asana.deletestatus |
Write |
Get status updates from an object — asana.getstatusesforobject |
Read |
Create a status update — asana.createstatusforobject |
Write |
Get a story — asana.getstory |
Read |
Update a story — asana.updatestory |
Write |
Delete a story — asana.deletestory |
Write |
Get stories from a task — asana.getstoriesfortask |
Read |
Create a story on a task — asana.createstoryfortask |
Write |
Get stories from a record — asana.getstoriesforrecord |
Read |
Create a story on a record — asana.createstoryforrecord |
Write |
Get stories from a goal — asana.getstoriesforgoal |
Read |
Create a story on a goal — asana.createstoryforgoal |
Write |
Get tables in a workspace — asana.gettablesforworkspace |
Read |
Create a table — asana.createtable |
Write |
Get a table — asana.gettable |
Read |
Update a table — asana.updatetable |
Write |
Delete a table — asana.deletetable |
Write |
Add a custom field to a table — asana.addcustomfieldsettingfortable |
Write |
Remove a custom field from a table — asana.removecustomfieldsettingfortable |
Write |
Get a table's custom field settings — asana.getcustomfieldsettingsfortable |
Read |
Get multiple tags — asana.gettags |
Read |
Create a tag — asana.createtag |
Write |
Get a tag — asana.gettag |
Read |
Update a tag — asana.updatetag |
Write |
Delete a tag — asana.deletetag |
Write |
Get a task's tags — asana.gettagsfortask |
Read |
Get tags in a workspace — asana.gettagsforworkspace |
Read |
Create a tag in a workspace — asana.createtagforworkspace |
Write |
Get multiple task templates — asana.gettasktemplates |
Read |
Get a task template — asana.gettasktemplate |
Read |
Delete a task template — asana.deletetasktemplate |
Write |
Instantiate a task from a task template — asana.instantiatetask |
Write |
Get multiple tasks — asana.gettasks |
Read |
Create a task — asana.createtask |
Write |
Get a task — asana.gettask |
Read |
Update a task — asana.updatetask |
Write |
Delete a task — asana.deletetask |
Write |
Duplicate a task — asana.duplicatetask |
Write |
Get tasks from a project — asana.gettasksforproject |
Read |
Get tasks from a section — asana.gettasksforsection |
Read |
Get tasks from a tag — asana.gettasksfortag |
Read |
Get tasks from a user task list — asana.gettasksforusertasklist |
Read |
Get subtasks from a task — asana.getsubtasksfortask |
Read |
Create a subtask — asana.createsubtaskfortask |
Write |
Set the parent of a task — asana.setparentfortask |
Write |
Get dependencies from a task — asana.getdependenciesfortask |
Read |
Set dependencies for a task — asana.adddependenciesfortask |
Write |
Unlink dependencies from a task — asana.removedependenciesfortask |
Write |
Get dependents from a task — asana.getdependentsfortask |
Read |
Set dependents for a task — asana.adddependentsfortask |
Write |
Unlink dependents from a task — asana.removedependentsfortask |
Write |
Add a project to a task — asana.addprojectfortask |
Write |
Remove a project from a task — asana.removeprojectfortask |
Write |
Add a tag to a task — asana.addtagfortask |
Write |
Remove a tag from a task — asana.removetagfortask |
Write |
Add followers to a task — asana.addfollowersfortask |
Write |
Remove followers from a task — asana.removefollowerfortask |
Write |
Roll up subtask dates for a task — asana.rolluptask |
Write |
Get a task for a given custom ID — asana.gettaskforcustomid |
Read |
Search tasks in a workspace — asana.searchtasksforworkspace |
Read |
Get a team membership — asana.getteammembership |
Read |
Get team memberships — asana.getteammemberships |
Read |
Get memberships from a team — asana.getteammembershipsforteam |
Read |
Get memberships from a user — asana.getteammembershipsforuser |
Read |
Create a team — asana.createteam |
Write |
Get a team — asana.getteam |
Read |
Update a team — asana.updateteam |
Write |
Get teams in a workspace — asana.getteamsforworkspace |
Read |
Get teams for a user — asana.getteamsforuser |
Read |
Add a user to a team — asana.adduserforteam |
Write |
Remove a user from a team — asana.removeuserforteam |
Write |
Get a time period — asana.gettimeperiod |
Read |
Get time periods — asana.gettimeperiods |
Read |
Get a time tracking category — asana.gettimetrackingcategory |
Read |
Update a time tracking category — asana.updatetimetrackingcategory |
Write |
Delete a time tracking category — asana.deletetimetrackingcategory |
Write |
Get time tracking entries for a time tracking category — asana.gettimetrackingentriesfortimetrackingcategory |
Read |
Get time tracking categories for a workspace — asana.gettimetrackingcategories |
Read |
Create a time tracking category — asana.createtimetrackingcategory |
Write |
Get time tracking entries for a task — asana.gettimetrackingentriesfortask |
Read |
Create a time tracking entry — asana.createtimetrackingentry |
Write |
Get a time tracking entry — asana.gettimetrackingentry |
Read |
Update a time tracking entry — asana.updatetimetrackingentry |
Write |
Delete a time tracking entry — asana.deletetimetrackingentry |
Write |
Get multiple time tracking entries — asana.gettimetrackingentries |
Read |
Get a timesheet approval status — asana.gettimesheetapprovalstatus |
Read |
Update a timesheet approval status — asana.updatetimesheetapprovalstatus |
Write |
Get multiple timesheet approval statuses — asana.gettimesheetapprovalstatuses |
Read |
Create a timesheet approval status — asana.createtimesheetapprovalstatus |
Write |
Get objects via typeahead — asana.typeaheadforworkspace |
Read |
Get a user task list — asana.getusertasklist |
Read |
Get a user's task list — asana.getusertasklistforuser |
Read |
Get multiple users — asana.getusers |
Read |
Get a user — asana.getuser |
Read |
Update a user — asana.updateuser |
Write |
Get a user's favorites — asana.getfavoritesforuser |
Read |
Get users in a team — asana.getusersforteam |
Read |
Get users in a workspace or organization — asana.getusersforworkspace |
Read |
Get a user in a workspace or organization — asana.getuserforworkspace |
Read |
Update a user in a workspace or organization — asana.updateuserforworkspace |
Write |
Get multiple webhooks — asana.getwebhooks |
Read |
Establish a webhook — asana.createwebhook |
Write |
Get a webhook — asana.getwebhook |
Read |
Update a webhook — asana.updatewebhook |
Write |
Delete a webhook — asana.deletewebhook |
Write |
Get a workspace membership — asana.getworkspacemembership |
Read |
Get workspace memberships for a user — asana.getworkspacemembershipsforuser |
Read |
Get the workspace memberships for a workspace — asana.getworkspacemembershipsforworkspace |
Read |
Get multiple workspaces — asana.getworkspaces |
Read |
Get a workspace — asana.getworkspace |
Read |
Update a workspace — asana.updateworkspace |
Write |
Add a user to a workspace or organization — asana.adduserforworkspace |
Write |
Remove a user from a workspace or organization — asana.removeuserforworkspace |
Write |
Get workspace events — asana.getworkspaceevents |
Read |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for Asana, then enter the issued values in the connection form below.
- Open the Asana developer console from Settings → Apps → Manage Developer Apps, then select Create new token. Name it, copy the personal access token and enter it in this connection’s Asana personal access token field. It inherits your account’s access. Enable the commands you need, save, and create a Tooluse.net API key for your client. Use Asana resource GIDs and explicit pagination cursors from the command examples.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| Asana personal access token | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {
"query": {
"target": "1331"
}
}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Get access requests — asana.getaccessrequests
Returns the pending access requests for a target object or a target object filtered by user.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.target |
string | Required | Globally unique identifier for the target object. | |
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","message","requester","requester.name","target"] |
Full JSON Schema
Example input
{
"query": {
"target": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an access request — asana.createaccessrequest
Submits a new access request for a private object. Currently supports projects and portfolios.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AccessRequestCreateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Approve an access request — asana.approveaccessrequest
Approves an access request for a target object.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_request_gid |
string | Required | Globally unique identifier for the access request. |
Full JSON Schema
Example input
{
"path": {
"access_request_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reject an access request — asana.rejectaccessrequest
Rejects an access request for a target object.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_request_gid |
string | Required | Globally unique identifier for the access request. |
Full JSON Schema
Example input
{
"path": {
"access_request_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a list of agents in a workspace — asana.getagentsforworkspace
Returns the compact records of agents (AI Teammates) configured. Use opt_fields to request additional fields in the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["behavior_guidance","description","name","offset","path","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","resource_subtype","uri","workspace"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an agent — asana.getagent
Returns the complete record for a single agent (AI Teammate).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_gid |
string | Required | Globally unique identifier for the agent. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["behavior_guidance","description","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","resource_subtype","workspace"] |
Full JSON Schema
Example input
{
"path": {
"agent_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get AI Studio credit utilization — asana.getaistudioruns
Returns one row per AI Studio run (rule execution) for the workspace, in ascending order (oldest first) so that incremental consumers can poll forward. Each row describes what ran, who it is attributed to, the model used, and the credits consumed.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.start_at |
string | Optional | Inclusive lower bound. Runs are ordered and filtered by when their usage was recorded (the monotonic timestamp used for incremental polling), not by run_started_at. Omitted ⇒ the 2025-01-08 floor — no credit data exists before then, and there is no limit on how far back you can query. A value earlier than 2025-01-08 is treated as 2025-01-08 (not rejected), matching the audit log. |
format: "date-time" |
query.end_at |
string | Optional | Filter to runs whose usage was recorded before this time (exclusive) — by when the run's credit usage was recorded, not by run_started_at. Defaults to the time of the request. |
format: "date-time" |
query.division_gid |
string | Optional | Scope results to a single division (its gid). Omitted ⇒ the org's first licensed division. Use this to retrieve only one division's slice (e.g. for a division-level admin or billing owner) rather than the whole organization. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get AI Studio seats — asana.getaistudioseats
Returns a current snapshot of AI Studio seat allocations for the workspace — who has access, at what license tier, and the state of each seat. This is a point-in-time snapshot; customers build their own history tables on top of periodic pulls.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.state |
string | Optional | Filter seats to this state. | enum: ["active","revoked"] |
query.division_gid |
string | Optional | Scope results to a single division (its gid). Omitted ⇒ the org's first licensed division. Use this to retrieve only one division's slice (e.g. for a division-level admin or billing owner) rather than the whole organization. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an allocation — asana.getallocation
Returns the complete allocation record for a single allocation.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.allocation_gid |
string | Required | Globally unique identifier for the allocation. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","created_by","created_by.name","effort","effort.type","effort.value","end_date","parent","parent.name","parent.resource_subtype","resource_subtype","start_date"] |
Full JSON Schema
Example input
{
"path": {
"allocation_gid": "77688"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an allocation — asana.updateallocation
An existing allocation can be updated by making a PUT request on the URL for that allocation. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.allocation_gid |
string | Required | Globally unique identifier for the allocation. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","created_by","created_by.name","effort","effort.type","effort.value","end_date","parent","parent.name","parent.resource_subtype","resource_subtype","start_date"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AllocationRequest" |
Full JSON Schema
Example input
{
"path": {
"allocation_gid": "77688"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an allocation — asana.deleteallocation
A specific, existing allocation can be deleted by making a DELETE request on the URL for that allocation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.allocation_gid |
string | Required | Globally unique identifier for the allocation. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"allocation_gid": "77688"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple allocations — asana.getallocations
Returns a list of allocations filtered to a specific project, user or placeholder.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.parent |
string | Optional | Globally unique identifier for the project to filter allocations by. | |
query.assignee |
string | Optional | Globally unique identifier for the user or placeholder the allocation is assigned to. | |
query.workspace |
string | Optional | Globally unique identifier for the workspace. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","created_by","created_by.name","effort","effort.type","effort.value","end_date","offset","parent","parent.name","parent.resource_subtype","path","resource_subtype","start_date","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an allocation — asana.createallocation
Creates a new allocation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","created_by","created_by.name","effort","effort.type","effort.value","end_date","parent","parent.name","parent.resource_subtype","resource_subtype","start_date"] |
|
body |
object | Required | ||
body.data |
— | Optional | ||
body.data |
— | Optional | allOf[1]; $ref: "#/definitions/AllocationRequest" |
|
body.data |
object | Optional | allOf[2] |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an attachment — asana.getattachment
Required scope: attachments:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.attachment_gid |
string | Required | Globally unique identifier for the attachment. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["connected_to_app","created_at","download_url","host","name","parent","parent.created_by","parent.name","parent.resource_subtype","permanent_url","resource_subtype","size","view_url"] |
Full JSON Schema
Example input
{
"path": {
"attachment_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an attachment — asana.deleteattachment
Required scope: attachments:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.attachment_gid |
string | Required | Globally unique identifier for the attachment. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"attachment_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get attachments from an object — asana.getattachmentsforobject
Required scope: attachments:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.parent |
string | Required | Globally unique identifier for the object to fetch attachments from. Must be a GID for a project, project_brief, or task. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["connected_to_app","created_at","download_url","host","name","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permanent_url","resource_subtype","size","uri","view_url"] |
Full JSON Schema
Example input
{
"query": {
"parent": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get audit log events — asana.getauditlogevents
Retrieve the audit log events that have been captured in your domain.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.start_at |
string | Optional | Filter to events created after this time (inclusive). | format: "date-time" |
query.end_at |
string | Optional | Filter to events created before this time (exclusive). | format: "date-time" |
query.event_type |
string | Optional | Filter to events of this type. Refer to the supported audit log events for a full list of values. | |
query.actor_type |
string | Optional | Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If actor_gid is included, this should be excluded. |
enum: ["user","asana","asana_support","anonymous","external_administrator"] |
query.actor_gid |
string | Optional | Filter to events triggered by the actor with this ID. | |
query.resource_gid |
string | Optional | Filter to events with this resource ID. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Submit parallel requests — asana.createbatchrequest
Make multiple requests in parallel to Asana's API.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["body","headers","status_code"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/BatchRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get all budgets — asana.getbudgets
Gets all budgets for a given parent. This will at most return a list of size 1 for a given parent.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.parent |
string | Required | Globally unique identifier for the budget's parent object. This currently can only be a project. |
Full JSON Schema
Example input
{
"query": {
"parent": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a budget — asana.createbudget
Creates a new budget.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/BudgetRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a budget — asana.getbudget
Returns the complete budget record for a single budget.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.budget_gid |
string | Required | Globally unique identifier for the budget. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual","actual.billable_status_filter","actual.units","actual.value","budget_type","estimate","estimate.billable_status_filter","estimate.enabled","estimate.source","estimate.units","estimate.value","parent","parent.name","parent.resource_subtype","total","total.enabled","total.units","total.value"] |
Full JSON Schema
Example input
{
"path": {
"budget_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a budget — asana.updatebudget
An existing budget can be updated by making a PUT request on the URL for that budget. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.budget_gid |
string | Required | Globally unique identifier for the budget. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual","actual.billable_status_filter","actual.units","actual.value","budget_type","estimate","estimate.billable_status_filter","estimate.enabled","estimate.source","estimate.units","estimate.value","parent","parent.name","parent.resource_subtype","total","total.enabled","total.units","total.value"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/BudgetRequest" |
Full JSON Schema
Example input
{
"path": {
"budget_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a budget — asana.deletebudget
A specific, existing budget can be deleted by making a DELETE request on the URL for that budget.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.budget_gid |
string | Required | Globally unique identifier for the budget. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"budget_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project's custom fields — asana.getcustomfieldsettingsforproject
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.default_access_level","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.html_text_value","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_lookup_field","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.privacy_setting","custom_field.reference_value","custom_field.reference_value.name","custom_field.representation_type","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","parent.resource_subtype","path","project","project.name","project.resource_subtype","uri"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a portfolio's custom fields — asana.getcustomfieldsettingsforportfolio
Required scope: portfolios:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.default_access_level","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.html_text_value","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_lookup_field","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.privacy_setting","custom_field.reference_value","custom_field.reference_value.name","custom_field.representation_type","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","parent.resource_subtype","path","project","project.name","project.resource_subtype","uri"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a goal's custom fields — asana.getcustomfieldsettingsforgoal
Required scope: goals:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.default_access_level","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.html_text_value","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_lookup_field","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.privacy_setting","custom_field.reference_value","custom_field.reference_value.name","custom_field.representation_type","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","offset","parent","parent.name","parent.resource_subtype","path","project","project.name","project.resource_subtype","uri"] |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a team's custom fields — asana.getcustomfieldsettingsforteam
Required scope: teams:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.default_access_level","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.html_text_value","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_lookup_field","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.privacy_setting","custom_field.reference_value","custom_field.reference_value.name","custom_field.representation_type","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","parent","parent.name","parent.resource_subtype","project","project.name","project.resource_subtype"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a custom field — asana.createcustomfield
Required scope: custom_fields:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","default_access_level","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","html_text_value","id_prefix","input_restrictions","is_formula_field","is_global_to_workspace","is_lookup_field","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","privacy_setting","reference_value","reference_value.name","representation_type","resource_subtype","text_value","type"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/CustomFieldCreateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a custom field — asana.getcustomfield
Required scope: custom_fields:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_field_gid |
string | Required | Globally unique identifier for the custom field. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","default_access_level","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","html_text_value","id_prefix","input_restrictions","is_formula_field","is_global_to_workspace","is_lookup_field","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","privacy_setting","reference_value","reference_value.name","representation_type","resource_subtype","text_value","type"] |
Full JSON Schema
Example input
{
"path": {
"custom_field_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a custom field — asana.updatecustomfield
Required scope: custom_fields:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_field_gid |
string | Required | Globally unique identifier for the custom field. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","default_access_level","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","html_text_value","id_prefix","input_restrictions","is_formula_field","is_global_to_workspace","is_lookup_field","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","people_value","people_value.name","precision","privacy_setting","reference_value","reference_value.name","representation_type","resource_subtype","text_value","type"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/CustomFieldRequest" |
Full JSON Schema
Example input
{
"path": {
"custom_field_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a custom field — asana.deletecustomfield
A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_field_gid |
string | Required | Globally unique identifier for the custom field. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"custom_field_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a workspace's custom fields — asana.getcustomfieldsforworkspace
Required scope: custom_fields:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_field","created_by","created_by.name","currency_code","custom_label","custom_label_position","date_value","date_value.date","date_value.date_time","default_access_level","description","display_value","enabled","enum_options","enum_options.color","enum_options.enabled","enum_options.name","enum_value","enum_value.color","enum_value.enabled","enum_value.name","format","has_notifications_enabled","html_text_value","id_prefix","input_restrictions","is_formula_field","is_global_to_workspace","is_lookup_field","is_value_read_only","multi_enum_values","multi_enum_values.color","multi_enum_values.enabled","multi_enum_values.name","name","number_value","offset","path","people_value","people_value.name","precision","privacy_setting","reference_value","reference_value.name","representation_type","resource_subtype","text_value","type","uri"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an enum option — asana.createenumoptionforcustomfield
Required scope: custom_fields:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_field_gid |
string | Required | Globally unique identifier for the custom field. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","enabled","name"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/EnumOptionRequest" |
Full JSON Schema
Example input
{
"path": {
"custom_field_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reorder a custom field's enum — asana.insertenumoptionforcustomfield
Required scope: custom_fields:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_field_gid |
string | Required | Globally unique identifier for the custom field. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","enabled","name"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/EnumOptionInsertRequest" |
Full JSON Schema
Example input
{
"path": {
"custom_field_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an enum option — asana.updateenumoption
Required scope: custom_fields:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.enum_option_gid |
string | Required | Globally unique identifier for the enum option. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","enabled","name"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/EnumOptionBase" |
Full JSON Schema
Example input
{
"path": {
"enum_option_gid": "124578"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get all custom types associated with an object — asana.getcustomtypes
Required scope: custom_types:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.project |
string | Optional | Globally unique identifier for the project, used as a filter when retrieving custom types. | |
query.workspace |
string | Optional | The workspace to filter results on. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_type_identifier","name","offset","path","status_options","status_options.color","status_options.completion_state","status_options.enabled","status_options.name","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a custom type — asana.getcustomtype
Required scope: custom_types:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.custom_type_gid |
string | Required | Globally unique identifier for the custom type. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["asana_created_type_identifier","name","status_options","status_options.color","status_options.completion_state","status_options.enabled","status_options.name"] |
Full JSON Schema
Example input
{
"path": {
"custom_type_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get events on a resource — asana.getevents
Returns the full record for all events that have occurred since the sync token was created.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.resource |
string | Required | A resource ID to subscribe to. The resource can be a task, project, or goal. | |
query.sync |
string | Optional | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a 412 Precondition Failed error, and include a fresh sync token in the response. |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["action","change","change.action","change.added_value","change.field","change.new_value","change.removed_value","created_at","parent","parent.name","resource","resource.name","type","user","user.name"] |
Full JSON Schema
Example input
{
"query": {
"resource": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a graph export — asana.creategraphexport
Initiates a graph export job for a given parent object (goal, team, portfolio, or project). The export will be processed asynchronously. Once initiated, use the jobs endpoint to monitor progress.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GraphExportRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a resource export — asana.createresourceexport
Initiates a bulk export of resources for a workspace. The export will be processed asynchronously. Once the export has been requested, its progress can be monitored using the jobs endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ResourceExportRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a goal relationship — asana.getgoalrelationship
Returns the complete updated goal relationship record for a single goal relationship.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_relationship_gid |
string | Required | Globally unique identifier for the goal relationship. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","supporting_resource.resource_subtype"] |
Full JSON Schema
Example input
{
"path": {
"goal_relationship_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a goal relationship — asana.updategoalrelationship
An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_relationship_gid |
string | Required | Globally unique identifier for the goal relationship. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","supporting_resource.resource_subtype"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalRelationshipRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_relationship_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get goal relationships — asana.getgoalrelationships
Returns compact goal relationship records.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.supported_goal |
string | Required | Globally unique identifier for the supported goal in the goal relationship. | |
query.resource_subtype |
string | Optional | If provided, filter to goal relationships with a given resource_subtype. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["contribution_weight","offset","path","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","supporting_resource.resource_subtype","uri"] |
Full JSON Schema
Example input
{
"query": {
"supported_goal": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a supporting goal relationship — asana.addsupportingrelationship
Creates a goal relationship by adding a supporting resource to a given goal.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["contribution_weight","resource_subtype","supported_goal","supported_goal.name","supported_goal.owner","supported_goal.owner.name","supporting_resource","supporting_resource.name","supporting_resource.resource_subtype"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalAddSupportingRelationshipRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Removes a supporting goal relationship — asana.removesupportingrelationship
Removes a goal relationship for a given parent goal.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalRemoveSupportingRelationshipRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a goal — asana.getgoal
Required scope: goals:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a goal — asana.updategoal
An existing goal can be updated by making a PUT request on the URL for that goal. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a goal — asana.deletegoal
A specific, existing goal can be deleted by making a DELETE request on the URL for that goal.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get goals — asana.getgoals
Required scope: goals:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.portfolio |
string | Optional | Globally unique identifier for supporting portfolio. | |
query.project |
string | Optional | Globally unique identifier for supporting project. | |
query.task |
string | Optional | Globally unique identifier for supporting task. | |
query.is_workspace_level |
boolean | Optional | Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. | |
query.team |
string | Optional | Globally unique identifier for the team. | |
query.workspace |
string | Optional | Globally unique identifier for the workspace. | |
query.time_periods |
array | Optional | Globally unique identifiers for the time periods. | |
query.time_periods[] |
string | Optional | ||
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","offset","owner","owner.name","path","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a goal — asana.creategoal
Creates a new goal in a workspace or team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a goal metric — asana.creategoalmetric
Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalMetricRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a goal metric — asana.updategoalmetric
Updates a goal's existing metric's current_number_value if one exists, otherwise responds with a 400 status code.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/GoalMetricCurrentValueRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a collaborator to a goal — asana.addfollowers
Adds followers to a goal. Returns the goal the followers were added to. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskAddFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a collaborator from a goal — asana.removefollowers
Removes followers from a goal. Returns the goal the followers were removed from. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskAddFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get parent goals from a goal — asana.getparentgoalsforgoal
Required scope: goals:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","default_access_level","due_on","followers","followers.name","html_notes","is_workspace_level","liked","likes","likes.user","likes.user.name","metric","metric.can_manage","metric.currency_code","metric.current_display_value","metric.current_number_value","metric.initial_number_value","metric.is_custom_weight","metric.precision","metric.progress_source","metric.resource_subtype","metric.target_number_value","metric.unit","name","notes","num_likes","owner","owner.name","privacy_setting","start_on","status","team","team.name","time_period","time_period.display_name","time_period.end_on","time_period.period","time_period.start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a custom field to a goal — asana.addcustomfieldsettingforgoal
Required scope: goals:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a custom field from a goal — asana.removecustomfieldsettingforgoal
Required scope: goals:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a job by id — asana.getjob
Required scope: jobs:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_gid |
string | Required | Globally unique identifier for the job. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
Full JSON Schema
Example input
{
"path": {
"job_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple memberships — asana.getmemberships
Returns compact goal_membership, project_membership, portfolio_membership, custom_type_membership, custom_field_membership, table_membership, or record_membership records. The possible types for parent in this request are goal, project, portfolio, custom_type, custom_field, table, or record. An additional member (user GID or team GID) can be passed in to filter to a specific membership.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.parent |
string | Optional | Globally unique identifier for goal, project, portfolio, custom_type, custom_field, table, or record. This parameter is optional when resource_subtype is provided along with member of type team. |
|
query.member |
string | Optional | Globally unique identifier for team or user. When used with resource_subtype and without parent, member must be of type team. For user-type memberships parent parameter is required to disambiguate the workspace from which memberships should be retrieved. |
|
query.resource_subtype |
string | Optional | The type of membership to return. Required when parent is absent. Currently supported value is project_membership (when member is a team GID, returns all project memberships for that team). |
enum: ["project_membership"] |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["offset","path","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a membership — asana.createmembership
Creates a new membership in a goal, project, portfolio, custom_type, custom_field, table, or record, where members can be Teams or Users.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/CreateMembershipRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a membership — asana.getmembership
Returns a project_membership, goal_membership, portfolio_membership, custom_type_membership, custom_field_membership, table_membership, or record_membership record for a membership id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.membership_gid |
string | Required | Globally unique identifier for the membership. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"membership_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a membership — asana.updatemembership
An existing membership can be updated by making a PUT request on the membership. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. Memberships on goals, projects, portfolios, custom_types, custom_fields, tables, and records can be updated. Returns the full record of the updated membership.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.membership_gid |
string | Required | Globally unique identifier for the membership. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/MembershipRequest" |
Full JSON Schema
Example input
{
"path": {
"membership_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a membership — asana.deletemembership
A specific, existing membership for a goal, project, portfolio, custom_type, custom_field, table, or record can be deleted by making a DELETE request on the URL for that membership.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.membership_gid |
string | Required | Globally unique identifier for the membership. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"membership_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get notifications for a user — asana.getnotificationsforuser
Required scope: notifications:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Required | GID of the workspace from which to return notifications. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","created_by","created_by.name","is_read","offset","path","priority_classification","story","story_resource_subtype","uri","work_objects","work_objects.name"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"query": {
"workspace": "31326"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Mark notifications as read — asana.marknotificationsreadforuser
Required scope: notifications:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["failed_gids"] |
|
body |
object | Required | ||
body.data |
— | Required | $ref: "#/definitions/MarkNotificationsRequest" |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"body": {
"data": {
"workspace": "31326",
"notification_gids": [
"1234567890",
"1234567891"
]
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Mark notifications as unread — asana.marknotificationsunreadforuser
Required scope: notifications:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["failed_gids"] |
|
body |
object | Required | ||
body.data |
— | Required | $ref: "#/definitions/MarkNotificationsRequest" |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"body": {
"data": {
"workspace": "31326",
"notification_gids": [
"1234567890",
"1234567891"
]
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an OOO entry — asana.getoooentry
Required scope: ooo_entries:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ooo_entry_gid |
string | Required | Globally unique identifier for the OOO entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","end_date","start_date","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"ooo_entry_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an OOO entry — asana.updateoooentry
Required scope: ooo_entries:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ooo_entry_gid |
string | Required | Globally unique identifier for the OOO entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","end_date","start_date","user","user.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/OooEntryUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"ooo_entry_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an OOO entry — asana.deleteoooentry
Required scope: ooo_entries:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ooo_entry_gid |
string | Required | Globally unique identifier for the OOO entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"ooo_entry_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get OOO entries for a user — asana.getoooentries
Required scope: ooo_entries:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.user |
string | Required | Globally unique identifier for the user to filter OOO entries by. | |
query.workspace |
string | Required | Globally unique identifier for the workspace. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.start_date |
string | Optional | An ISO 8601 date string. Filters to OOO entries that overlap with or end after this date. | format: "date" |
query.end_date |
string | Optional | An ISO 8601 date string. Filters to OOO entries that overlap with or start before this date. | format: "date" |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","end_date","offset","path","start_date","uri","user","user.name"] |
Full JSON Schema
Example input
{
"query": {
"user": "12345",
"workspace": "98765"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an OOO entry — asana.createoooentry
Required scope: ooo_entries:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","end_date","start_date","user","user.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | ||
body.data |
— | Optional | allOf[1]; $ref: "#/definitions/OooEntryCreateRequest" |
|
body.data |
object | Optional | allOf[2] |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an organization export request — asana.createorganizationexport
This method creates a request to export an Organization. Asana will complete the export at some point after you create the request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","download_url","organization","organization.name","state"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/OrganizationExportRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get details on an org export request — asana.getorganizationexport
Returns details of a previously-requested Organization export.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.organization_export_gid |
string | Required | Globally unique identifier for the organization export. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","download_url","organization","organization.name","state"] |
Full JSON Schema
Example input
{
"path": {
"organization_export_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple portfolio memberships — asana.getportfoliomemberships
Returns a list of portfolio memberships in compact representation. You must specify portfolio, portfolio and user, or workspace and user.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.portfolio |
string | Optional | The portfolio to filter results on. | |
query.workspace |
string | Optional | The workspace to filter results on. | |
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["access_level","offset","path","portfolio","portfolio.name","portfolio.resource_subtype","uri","user","user.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a portfolio membership — asana.getportfoliomembership
Returns the complete portfolio record for a single portfolio membership.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_membership_gid |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["access_level","portfolio","portfolio.name","portfolio.resource_subtype","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_membership_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get memberships from a portfolio — asana.getportfoliomembershipsforportfolio
Returns the compact portfolio membership records for the portfolio.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["access_level","offset","path","portfolio","portfolio.name","portfolio.resource_subtype","uri","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple portfolios — asana.getportfolios
Required scope: portfolios:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.workspace |
string | Required | The workspace or organization to filter portfolios on. | |
query.owner |
string | Optional | The user who owns the portfolios. For regular API users (PAT or OAuth), defaults to the current API user when omitted and must identify that user when specified; use me to refer to the current API user. For Service Accounts, if this parameter is specified, only portfolios owned by the specified user are returned. If a Service Account omits this parameter, all portfolios across the workspace are returned. |
|
query.custom_type |
string | Optional | Filter results by custom type. Provide a custom type GID to return only objects of that custom type (an unknown GID returns 400). Provide an empty string to return only objects with no custom type assigned. If this parameter is omitted, results are not filtered by custom type. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","offset","owner","owner.name","path","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a portfolio — asana.createportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","owner","owner.name","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/PortfolioRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a portfolio — asana.getportfolio
Required scope: portfolios:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","owner","owner.name","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a portfolio — asana.updateportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","owner","owner.name","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/PortfolioUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a portfolio — asana.deleteportfolio
An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get portfolio items — asana.getitemsforportfolio
Required scope: portfolios:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["offset","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a portfolio item — asana.additemforportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/PortfolioAddItemRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a portfolio item — asana.removeitemforportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/PortfolioRemoveItemRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a custom field to a portfolio — asana.addcustomfieldsettingforportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a custom field from a portfolio — asana.removecustomfieldsettingforportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add users to a portfolio — asana.addmembersforportfolio
Adds the specified list of users as members of the portfolio. Returns the updated portfolio record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","owner","owner.name","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddMembersRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove users from a portfolio — asana.removemembersforportfolio
Removes the specified list of users from members of the portfolio. Returns the updated portfolio record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","created_at","created_by","created_by.name","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","due_on","members","members.name","name","owner","owner.name","permalink_url","privacy_setting","project_templates","project_templates.name","public","resource_subtype","start_on","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveMembersRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate a portfolio — asana.duplicateportfolio
Required scope: portfolios:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/PortfolioDuplicateRequest" |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project brief — asana.getprojectbrief
Get the full record for a project brief.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_brief_gid |
string | Required | Globally unique identifier for the project brief. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["html_text","permalink_url","project","project.name","project.resource_subtype","text","title"] |
Full JSON Schema
Example input
{
"path": {
"project_brief_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a project brief — asana.updateprojectbrief
An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_brief_gid |
string | Required | Globally unique identifier for the project brief. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["html_text","permalink_url","project","project.name","project.resource_subtype","text","title"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectBriefRequest" |
Full JSON Schema
Example input
{
"path": {
"project_brief_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a project brief — asana.deleteprojectbrief
Deletes a specific, existing project brief.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_brief_gid |
string | Required | Globally unique identifier for the project brief. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"project_brief_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project brief — asana.createprojectbrief
Creates a new project brief.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["html_text","permalink_url","project","project.name","project.resource_subtype","text","title"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectBriefRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project membership — asana.getprojectmembership
Returns the complete project record for a single project membership.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_membership_gid |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["access_level","member","member.name","parent","parent.name","parent.resource_subtype","project","project.name","project.resource_subtype","user","user.name","write_access"] |
Full JSON Schema
Example input
{
"path": {
"project_membership_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get memberships from a project — asana.getprojectmembershipsforproject
Returns the compact project membership records for the project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["access_level","member","member.name","offset","parent","parent.name","parent.resource_subtype","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project portfolio setting — asana.getprojectportfoliosetting
Required scope: project_portfolio_settings:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_portfolio_setting_gid |
string | Required | Globally unique identifier for the project portfolio setting. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_access_control_inherited","portfolio","project"] |
Full JSON Schema
Example input
{
"path": {
"project_portfolio_setting_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a project portfolio setting — asana.updateprojectportfoliosetting
Required scope: project_portfolio_settings:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_portfolio_setting_gid |
string | Required | Globally unique identifier for the project portfolio setting. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_access_control_inherited","portfolio","project"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectPortfolioSettingUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"project_portfolio_setting_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project portfolio settings for a project — asana.getprojectportfoliosettingsforproject
Required scope: project_portfolio_settings:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_access_control_inherited","offset","path","portfolio","project","uri"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project portfolio settings for a portfolio — asana.getprojectportfoliosettingsforportfolio
Required scope: project_portfolio_settings:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.portfolio_gid |
string | Required | Globally unique identifier for the portfolio. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_access_control_inherited","offset","path","portfolio","project","uri"] |
Full JSON Schema
Example input
{
"path": {
"portfolio_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project status — asana.getprojectstatus
Deprecated: new integrations should prefer the /status_updates/{status_gid} route.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_status_gid |
string | Required | The project status update to get. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] |
Full JSON Schema
Example input
{
"path": {
"project_status_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a project status — asana.deleteprojectstatus
Deprecated: new integrations should prefer the /status_updates/{status_gid} route.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_status_gid |
string | Required | The project status update to get. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"project_status_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get statuses from a project — asana.getprojectstatusesforproject
Deprecated: new integrations should prefer the /status_updates route.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","offset","path","text","title","uri"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project status — asana.createprojectstatusforproject
Deprecated: new integrations should prefer the /status_updates route.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","color","created_at","created_by","created_by.name","html_text","modified_at","text","title"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectStatusRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project template — asana.getprojecttemplate
Required scope: project_templates:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_template_gid |
string | Required | Globally unique identifier for the project template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","description","html_description","name","owner","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name"] |
Full JSON Schema
Example input
{
"path": {
"project_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a project template — asana.deleteprojecttemplate
A specific, existing project template can be deleted by making a DELETE request on the URL for that project template.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_template_gid |
string | Required | Globally unique identifier for the project template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"project_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple project templates — asana.getprojecttemplates
Required scope: project_templates:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Optional | The workspace to filter results on. | |
query.team |
string | Optional | The team to filter projects on. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a team's project templates — asana.getprojecttemplatesforteam
Required scope: project_templates:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","description","html_description","name","offset","owner","path","public","requested_dates","requested_dates.description","requested_dates.name","requested_roles","requested_roles.name","team","team.name","uri"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Instantiate a project from a project template — asana.instantiateproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_template_gid |
string | Required | Globally unique identifier for the project template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectTemplateInstantiateProjectRequest" |
Full JSON Schema
Example input
{
"path": {
"project_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple projects — asana.getprojects
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.workspace |
string | Optional | The workspace or organization to filter projects on. | |
query.team |
string | Optional | Deprecated. The team to filter projects on. Please use GET /memberships with { member: team, resource_subtype: project_membership } instead. |
|
query.archived |
boolean | Optional | Only return projects whose archived field takes on the value of this parameter. |
|
query.custom_type |
string | Optional | Filter results by custom type. Provide a custom type GID to return only objects of that custom type (an unknown GID returns 400). Provide an empty string to return only objects with no custom type assigned. If this parameter is omitted, results are not filtered by custom type. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project — asana.createproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a project — asana.getproject
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a project — asana.updateproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a project — asana.deleteproject
Required scope: projects:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate a project — asana.duplicateproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectDuplicateRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get projects a task is in — asana.getprojectsfortask
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.include_inherited_projects |
boolean | Optional | Opt-in, read-only. When true, the response also includes projects the task inherits from its ancestor tasks (in addition to its direct projects). Defaults to false, in which case only direct projects are returned. |
default: false |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a team's projects — asana.getprojectsforteam
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.archived |
boolean | Optional | Only return projects whose archived field takes on the value of this parameter. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project in a team — asana.createprojectforteam
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectRequest" |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get all projects in a workspace — asana.getprojectsforworkspace
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.archived |
boolean | Optional | Only return projects whose archived field takes on the value of this parameter. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","offset","owner","path","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project in a workspace — asana.createprojectforworkspace
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search projects in a workspace — asana.searchprojectsforworkspace
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per search response. The number of objects to return in one search response. The value must be between 1 and 100. Search responses have no next_page, so to retrieve further results, sort by created_at and repeat the query with a created_at.before or created_at.after filter that excludes the results you have already seen. |
minimum: 1; maximum: 100 |
query.text |
string | Optional | Performs full-text search on the project name. | |
query.sort_by |
string | Optional | One of due_date, created_at, completed_at, relevance, or modified_at, defaults to modified_at. |
enum: ["due_date","created_at","completed_at","modified_at","relevance"]; default: "modified_at" |
query.sort_ascending |
boolean | Optional | Default false. |
default: false |
query.completed |
boolean | Optional | Filter on project completion status. | |
query.teams.any |
string | Optional | Comma-separated list of team IDs. | |
query.owner.any |
string | Optional | Comma-separated list of user identifiers to filter on as project owners. This can either be the string "me", an email, or the gid of a user. | |
query.members.any |
string | Optional | Comma-separated list of user identifiers to filter on as members. This can either be the string "me", an email, or the gid of a user. | |
query.members.not |
string | Optional | Comma-separated list of user identifiers to exclude as members. This can either be the string "me", an email, or the gid of a user. | |
query.portfolios.any |
string | Optional | Comma-separated list of portfolio IDs to filter on. | |
query.completed_on |
string | null | Optional | ISO 8601 date string or null. |
format: "date" |
query.completed_on.before |
string | Optional | ISO 8601 date string. | format: "date" |
query.completed_on.after |
string | Optional | ISO 8601 date string. | format: "date" |
query.completed_at.before |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.completed_at.after |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.created_on |
string | null | Optional | ISO 8601 date string or null. |
format: "date" |
query.created_on.before |
string | Optional | ISO 8601 date string. | format: "date" |
query.created_on.after |
string | Optional | ISO 8601 date string. | format: "date" |
query.created_at.before |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.created_at.after |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.due_on |
string | null | Optional | ISO 8601 date string or null. |
format: "date" |
query.due_on.before |
string | Optional | ISO 8601 date string. | format: "date" |
query.due_on.after |
string | Optional | ISO 8601 date string. | format: "date" |
query.due_at.before |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.due_at.after |
string | Optional | ISO 8601 datetime string. | format: "date-time" |
query.start_on |
string | null | Optional | ISO 8601 date string or null. |
format: "date" |
query.start_on.before |
string | Optional | ISO 8601 date string. | format: "date" |
query.start_on.after |
string | Optional | ISO 8601 date string. | format: "date" |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a custom field to a project — asana.addcustomfieldsettingforproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.asana_created_field","custom_field.created_by","custom_field.created_by.name","custom_field.currency_code","custom_field.custom_label","custom_field.custom_label_position","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.default_access_level","custom_field.description","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.format","custom_field.has_notifications_enabled","custom_field.html_text_value","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_global_to_workspace","custom_field.is_lookup_field","custom_field.is_value_read_only","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.people_value","custom_field.people_value.name","custom_field.precision","custom_field.privacy_setting","custom_field.reference_value","custom_field.reference_value.name","custom_field.representation_type","custom_field.resource_subtype","custom_field.text_value","custom_field.type","is_important","parent","parent.name","parent.resource_subtype","project","project.name","project.resource_subtype"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a custom field from a project — asana.removecustomfieldsettingforproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get task count of a project — asana.gettaskcountsforproject
Required scope: projects:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["num_completed_milestones","num_completed_tasks","num_incomplete_milestones","num_incomplete_tasks","num_milestones","num_tasks"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add users to a project — asana.addmembersforproject
Adds the specified list of users as members of the project. Note that a user being added as a member may also be added as a follower as a result of this operation. This is because the user's default notification settings (i.e., in the "Notifications" tab of "My Profile Settings") will override this endpoint's default behavior of setting "Tasks added" notifications to false. Returns the updated project record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddMembersRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove users from a project — asana.removemembersforproject
Removes the specified list of users from members of the project. Returns the updated project record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveMembersRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add followers to a project — asana.addfollowersforproject
Adds the specified list of users as followers to the project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. Therefore, if the users are not already members of the project, they will also become members as a result of this operation. Returns the updated project record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove followers from a project — asana.removefollowersforproject
Removes the specified list of users from following the project, this will not affect project membership status. Returns the updated project record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project template from a project — asana.projectsaveastemplate
Creates and returns a job that will asynchronously handle the project template creation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectSaveAsTemplateRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Roll up subtask dates for a project — asana.rollupproject
Required scope: projects:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple rates — asana.getrates
Returns a list of rate records. The possible types for parent in this request are project. An additional resource (user GID or placeholder GID) can be passed in to filter to a specific rate.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.parent |
string | Optional | Globally unique identifier for project. |
|
query.resource |
string | Optional | Globally unique identifier for user or placeholder. |
|
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["offset","path","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a rate — asana.createrate
Creates a new rate for a parent + resource combination.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","currency_code","parent","parent.name","parent.resource_subtype","rate","resource","resource.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a rate — asana.getrate
Returns the complete rate record for a single rate.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.rate_gid |
string | Required | Globally unique identifier for the rate. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","currency_code","parent","parent.name","parent.resource_subtype","rate","resource","resource.name"] |
Full JSON Schema
Example input
{
"path": {
"rate_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a rate — asana.updaterate
An existing rate can be updated by making a PUT request on the URL for that rate. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the rate field.)
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.rate_gid |
string | Required | Globally unique identifier for the rate. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_by","created_by.name","currency_code","parent","parent.name","parent.resource_subtype","rate","resource","resource.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RateUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"rate_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a rate — asana.deleterate
Deletes a rate.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.rate_gid |
string | Required | Globally unique identifier for the rate. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"rate_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get reactions with an emoji base on an object. — asana.getreactionsonobject
Returns the reactions with a specified emoji base character on the object.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.target |
string | Required | Globally unique identifier for object to fetch reactions from. Must be a GID for a status update or story. | |
query.emoji_base |
string | Required | Only return reactions with this emoji base character. |
Full JSON Schema
Example input
{
"query": {
"target": "159874",
"emoji_base": "👍"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get records in a table — asana.getrecordsfortable
Required scope: records:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.modified_since |
string | Optional | Only return records that have been modified since the given time. | format: "date-time" |
query.sort_by |
string | Optional | Sort order for the records returned. If omitted, records are returned in their default order. | enum: ["created_at"] |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["comment_count","created_at","created_by","created_by.name","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","deleted_at","is_in_archived_table","modified_at","name","offset","path","permalink_url","table","table.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search records in a workspace — asana.searchrecordsforworkspace
Required scope: records:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.text |
string | Optional | Performs full-text search on the record name | |
query.teams.any |
string | Optional | Comma-separated list of team IDs | |
query.followers.any |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.followers.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.tables.any |
string | Optional | Comma-separated list of table IDs | |
query.tables.not |
string | Optional | Comma-separated list of table IDs | |
query.tables.all |
string | Optional | Comma-separated list of table IDs | |
query.created_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.created_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.created_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.created_at.before |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.created_at.after |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.sort_by |
string | Optional | One of created_at or modified_at, defaults to modified_at |
enum: ["created_at","modified_at"]; default: "modified_at" |
query.sort_ascending |
boolean | Optional | Default false |
default: false |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["comment_count","created_at","created_by","created_by.name","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","deleted_at","is_in_archived_table","modified_at","name","permalink_url","table","table.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a record — asana.createrecord
Required scope: records:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["comment_count","created_at","created_by","created_by.name","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","deleted_at","is_in_archived_table","modified_at","name","permalink_url","table","table.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RecordItemRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a record — asana.getrecord
Required scope: records:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.record_gid |
string | Required | Globally unique identifier for the record. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["comment_count","created_at","created_by","created_by.name","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","deleted_at","is_in_archived_table","modified_at","name","permalink_url","table","table.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"record_gid": "7331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a record — asana.updaterecord
Required scope: records:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.record_gid |
string | Required | Globally unique identifier for the record. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["comment_count","created_at","created_by","created_by.name","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","default_access_level","deleted_at","is_in_archived_table","modified_at","name","permalink_url","table","table.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RecordItemUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"record_gid": "7331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a record — asana.deleterecord
Required scope: records:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.record_gid |
string | Required | Globally unique identifier for the record. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"record_gid": "7331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple roles — asana.getroles
Required scope: roles:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.workspace |
string | Required | The workspace or organization to filter roles on. | |
query.archived |
boolean | Optional | Only return projects whose archived field takes on the value of this parameter. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["base_role_type","creation_time","description","is_standard_role","modified_at","name","offset","path","permissions","permissions.allowed_guest_invites","permissions.assign_roles","permissions.create_and_edit_ai_automations","permissions.create_and_edit_ai_teammates","permissions.create_app_authorization","permissions.create_global_custom_fields","permissions.create_goal","permissions.create_pat_authorization","permissions.create_portfolio","permissions.create_project","permissions.create_read_only_link","permissions.create_team","permissions.download_mobile_attachments","permissions.export_project_data","permissions.import_data","permissions.manage_roles","permissions.proactive_ai","permissions.share_goal_with_domain","permissions.share_portfolios_with_org","permissions.share_teams_with_org","permissions.standard_ai","permissions.task_deletion_policy","permissions.upload_attachments","permissions.view_public_teams","permissions.view_shared_with_org_portfolios","permissions.view_shared_with_org_projects","permissions.view_shared_with_org_tasks","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a role — asana.createrole
Required scope: roles:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["base_role_type","creation_time","description","is_standard_role","modified_at","name","permissions","permissions.allowed_guest_invites","permissions.assign_roles","permissions.create_and_edit_ai_automations","permissions.create_and_edit_ai_teammates","permissions.create_app_authorization","permissions.create_global_custom_fields","permissions.create_goal","permissions.create_pat_authorization","permissions.create_portfolio","permissions.create_project","permissions.create_read_only_link","permissions.create_team","permissions.download_mobile_attachments","permissions.export_project_data","permissions.import_data","permissions.manage_roles","permissions.proactive_ai","permissions.share_goal_with_domain","permissions.share_portfolios_with_org","permissions.share_teams_with_org","permissions.standard_ai","permissions.task_deletion_policy","permissions.upload_attachments","permissions.view_public_teams","permissions.view_shared_with_org_portfolios","permissions.view_shared_with_org_projects","permissions.view_shared_with_org_tasks","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RbacRoleRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a role — asana.getrole
Required scope: roles:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.role_gid |
string | Required | Globally unique identifier for the role. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["base_role_type","creation_time","description","is_standard_role","modified_at","name","permissions","permissions.allowed_guest_invites","permissions.assign_roles","permissions.create_and_edit_ai_automations","permissions.create_and_edit_ai_teammates","permissions.create_app_authorization","permissions.create_global_custom_fields","permissions.create_goal","permissions.create_pat_authorization","permissions.create_portfolio","permissions.create_project","permissions.create_read_only_link","permissions.create_team","permissions.download_mobile_attachments","permissions.export_project_data","permissions.import_data","permissions.manage_roles","permissions.proactive_ai","permissions.share_goal_with_domain","permissions.share_portfolios_with_org","permissions.share_teams_with_org","permissions.standard_ai","permissions.task_deletion_policy","permissions.upload_attachments","permissions.view_public_teams","permissions.view_shared_with_org_portfolios","permissions.view_shared_with_org_projects","permissions.view_shared_with_org_tasks","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"role_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a role — asana.updaterole
Required scope: roles:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.role_gid |
string | Required | Globally unique identifier for the role. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["base_role_type","creation_time","description","is_standard_role","modified_at","name","permissions","permissions.allowed_guest_invites","permissions.assign_roles","permissions.create_and_edit_ai_automations","permissions.create_and_edit_ai_teammates","permissions.create_app_authorization","permissions.create_global_custom_fields","permissions.create_goal","permissions.create_pat_authorization","permissions.create_portfolio","permissions.create_project","permissions.create_read_only_link","permissions.create_team","permissions.download_mobile_attachments","permissions.export_project_data","permissions.import_data","permissions.manage_roles","permissions.proactive_ai","permissions.share_goal_with_domain","permissions.share_portfolios_with_org","permissions.share_teams_with_org","permissions.standard_ai","permissions.task_deletion_policy","permissions.upload_attachments","permissions.view_public_teams","permissions.view_shared_with_org_portfolios","permissions.view_shared_with_org_projects","permissions.view_shared_with_org_tasks","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RbacRoleUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"role_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a role — asana.deleterole
Required scope: roles:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.role_gid |
string | Required | Globally unique identifier for the role. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"role_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Trigger a rule — asana.triggerrule
Trigger a rule which uses an "incoming web request" trigger.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.rule_trigger_gid |
string | Required | The ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RuleTriggerRequest" |
Full JSON Schema
Example input
{
"path": {
"rule_trigger_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a section — asana.getsection
Returns the complete record for a single section.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.section_gid |
string | Required | The globally unique identifier for the section. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","name","project","project.name","project.resource_subtype","projects","projects.name","projects.resource_subtype"] |
Full JSON Schema
Example input
{
"path": {
"section_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a section — asana.updatesection
A specific, existing section can be updated by making a PUT request on the URL for that project. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the name field.)
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.section_gid |
string | Required | The globally unique identifier for the section. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","name","project","project.name","project.resource_subtype","projects","projects.name","projects.resource_subtype"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/SectionRequest" |
Full JSON Schema
Example input
{
"path": {
"section_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a section — asana.deletesection
A specific, existing section can be deleted by making a DELETE request on the URL for that section.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.section_gid |
string | Required | The globally unique identifier for the section. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"section_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get sections in a project — asana.getsectionsforproject
Returns the compact records for all sections in the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","name","offset","path","project","project.name","project.resource_subtype","projects","projects.name","projects.resource_subtype","uri"] |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a section in a project — asana.createsectionforproject
Creates a new section in a project. Returns the full record of the newly created section.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","name","project","project.name","project.resource_subtype","projects","projects.name","projects.resource_subtype"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/SectionRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add task to section — asana.addtaskforsection
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.section_gid |
string | Required | The globally unique identifier for the section. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/SectionTaskInsertRequest" |
Full JSON Schema
Example input
{
"path": {
"section_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Move or Insert sections — asana.insertsectionforproject
Move sections relative to each other. One of before_section or after_section is required.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/ProjectSectionInsertRequest" |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a status update — asana.getstatus
Returns the complete record for a single status update.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.status_update_gid |
string | Required | Globally unique identifier for the status update. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","created_at","created_by","created_by.name","hearted","hearts","hearts.user","hearts.user.name","html_text","liked","likes","likes.user","likes.user.name","modified_at","num_hearts","num_likes","parent","parent.name","parent.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","status_type","text","title"] |
Full JSON Schema
Example input
{
"path": {
"status_update_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a status update — asana.deletestatus
Deletes a specific, existing status update.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.status_update_gid |
string | Required | Globally unique identifier for the status update. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"status_update_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get status updates from an object — asana.getstatusesforobject
Returns the compact status update records for all updates on the object.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.parent |
string | Required | Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. | |
query.created_since |
string | Optional | Only return statuses that have been created since the given time. | format: "date-time" |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","created_at","created_by","created_by.name","hearted","hearts","hearts.user","hearts.user.name","html_text","liked","likes","likes.user","likes.user.name","modified_at","num_hearts","num_likes","offset","parent","parent.name","parent.resource_subtype","path","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","status_type","text","title","uri"] |
Full JSON Schema
Example input
{
"query": {
"parent": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a status update — asana.createstatusforobject
Creates a new status update on an object. Returns the full record of the newly created status update.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["author","author.name","created_at","created_by","created_by.name","hearted","hearts","hearts.user","hearts.user.name","html_text","liked","likes","likes.user","likes.user.name","modified_at","num_hearts","num_likes","parent","parent.name","parent.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","status_type","text","title"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/StatusUpdateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a story — asana.getstory
Required scope: stories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.story_gid |
string | Required | Globally unique identifier for the story. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type"] |
Full JSON Schema
Example input
{
"path": {
"story_gid": "35678"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a story — asana.updatestory
Required scope: stories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.story_gid |
string | Required | Globally unique identifier for the story. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/StoryRequest" |
Full JSON Schema
Example input
{
"path": {
"story_gid": "35678"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a story — asana.deletestory
Required scope: stories:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.story_gid |
string | Required | Globally unique identifier for the story. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"story_gid": "35678"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get stories from a task — asana.getstoriesfortask
Required scope: stories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.created_after |
string | Optional | Only return stories created after this time. Applies to every story type; pair it with resource_subtype=comment_added to get just the comments added since a given moment. The bound is exclusive but has second granularity: it is truncated to the start of its second before filtering, so any story created within that same second is still returned. A client polling with the created_at of the last story it saw should expect to see that story again, and others alongside it, and should de-duplicate on gid. |
format: "date-time" |
query.resource_subtype |
string | Optional | Only return stories of this subtype. Only comment_added is supported, which narrows the response to comments and excludes activity such as assignments, due date changes, and project moves. Omit to return the full activity feed. |
enum: ["comment_added"] |
query.sort_ascending |
boolean | Optional | Creation-time order: true (the default) is oldest first, false is newest first. Pair false with limit to read only the most recent stories. Ordering is applied across the parent's stories; on a parent with an extremely large activity feed the feed may be truncated before it is ordered, so pair false with created_after to bound what is considered. |
default: true |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","offset","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","path","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type","uri"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a story on a task — asana.createstoryfortask
Required scope: stories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskStoryCreateRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get stories from a record — asana.getstoriesforrecord
Required scope: stories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.record_gid |
string | Required | Globally unique identifier for the record. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.created_after |
string | Optional | Only return stories created after this time. Applies to every story type; pair it with resource_subtype=comment_added to get just the comments added since a given moment. The bound is exclusive but has second granularity: it is truncated to the start of its second before filtering, so any story created within that same second is still returned. A client polling with the created_at of the last story it saw should expect to see that story again, and others alongside it, and should de-duplicate on gid. |
format: "date-time" |
query.resource_subtype |
string | Optional | Only return stories of this subtype. Only comment_added is supported, which narrows the response to comments and excludes activity such as assignments, due date changes, and project moves. Omit to return the full activity feed. |
enum: ["comment_added"] |
query.sort_ascending |
boolean | Optional | Creation-time order: true (the default) is oldest first, false is newest first. Pair false with limit to read only the most recent stories. Ordering is applied across the parent's stories; on a parent with an extremely large activity feed the feed may be truncated before it is ordered, so pair false with created_after to bound what is considered. |
default: true |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","offset","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","path","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type","uri"] |
Full JSON Schema
Example input
{
"path": {
"record_gid": "7331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a story on a record — asana.createstoryforrecord
Required scope: stories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.record_gid |
string | Required | Globally unique identifier for the record. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/StoryRequest" |
Full JSON Schema
Example input
{
"path": {
"record_gid": "7331"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get stories from a goal — asana.getstoriesforgoal
Required scope: stories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.created_after |
string | Optional | Only return stories created after this time. Applies to every story type; pair it with resource_subtype=comment_added to get just the comments added since a given moment. The bound is exclusive but has second granularity: it is truncated to the start of its second before filtering, so any story created within that same second is still returned. A client polling with the created_at of the last story it saw should expect to see that story again, and others alongside it, and should de-duplicate on gid. |
format: "date-time" |
query.resource_subtype |
string | Optional | Only return stories of this subtype. Only comment_added is supported, which narrows the response to comments and excludes activity such as assignments, due date changes, and project moves. Omit to return the full activity feed. |
enum: ["comment_added"] |
query.sort_ascending |
boolean | Optional | Creation-time order: true (the default) is oldest first, false is newest first. Pair false with limit to read only the most recent stories. Ordering is applied across the parent's stories; on a parent with an extremely large activity feed the feed may be truncated before it is ordered, so pair false with created_after to bound what is considered. |
default: true |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","offset","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","path","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type","uri"] |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a story on a goal — asana.createstoryforgoal
Required scope: stories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.goal_gid |
string | Required | Globally unique identifier for the goal. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["anchor_gid","assignee","assignee.name","comment_gid","created_at","created_by","created_by.name","custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","dependency","dependency.created_by","dependency.name","dependency.resource_subtype","duplicate_of","duplicate_of.created_by","duplicate_of.name","duplicate_of.resource_subtype","duplicated_from","duplicated_from.created_by","duplicated_from.name","duplicated_from.resource_subtype","follower","follower.name","hearted","hearts","hearts.user","hearts.user.name","html_text","is_editable","is_edited","is_pinned","liked","likes","likes.user","likes.user.name","new_approval_status","new_date_value","new_dates","new_dates.due_at","new_dates.due_on","new_dates.start_on","new_enum_value","new_enum_value.color","new_enum_value.enabled","new_enum_value.name","new_multi_enum_values","new_multi_enum_values.color","new_multi_enum_values.enabled","new_multi_enum_values.name","new_name","new_number_value","new_people_value","new_people_value.name","new_resource_subtype","new_section","new_section.name","new_text_value","num_hearts","num_likes","old_approval_status","old_date_value","old_dates","old_dates.due_at","old_dates.due_on","old_dates.start_on","old_enum_value","old_enum_value.color","old_enum_value.enabled","old_enum_value.name","old_multi_enum_values","old_multi_enum_values.color","old_multi_enum_values.enabled","old_multi_enum_values.name","old_name","old_number_value","old_people_value","old_people_value.name","old_resource_subtype","old_section","old_section.name","old_text_value","previews","previews.fallback","previews.footer","previews.header","previews.header_link","previews.html_text","previews.text","previews.title","previews.title_link","project","project.name","project.resource_subtype","reaction_summary","reaction_summary.count","reaction_summary.emoji_base","reaction_summary.reacted","reaction_summary.variant","resource_subtype","source","sticker_name","story","story.anchor_gid","story.comment_gid","story.created_at","story.created_by","story.created_by.name","story.resource_subtype","story.text","tag","tag.name","target","target.created_by","target.name","target.resource_subtype","task","task.created_by","task.name","task.resource_subtype","text","type"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/StoryRequest" |
Full JSON Schema
Example input
{
"path": {
"goal_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get tables in a workspace — asana.gettablesforworkspace
Required scope: tables:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","default_access_level","modified_at","name","offset","path","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a table — asana.createtable
Required scope: tables:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","default_access_level","modified_at","name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TableRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a table — asana.gettable
Required scope: tables:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","default_access_level","modified_at","name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a table — asana.updatetable
Required scope: tables:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","default_access_level","modified_at","name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TableUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a table — asana.deletetable
Required scope: tables:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a custom field to a table — asana.addcustomfieldsettingfortable
Required scope: tables:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","is_important"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/AddCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a custom field from a table — asana.removecustomfieldsettingfortable
Required scope: tables:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/RemoveCustomFieldSettingRequest" |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a table's custom field settings — asana.getcustomfieldsettingsfortable
Required scope: tables:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.table_gid |
string | Required | Globally unique identifier for the table. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field","custom_field.date_value","custom_field.date_value.date","custom_field.date_value.date_time","custom_field.display_value","custom_field.enabled","custom_field.enum_options","custom_field.enum_options.color","custom_field.enum_options.enabled","custom_field.enum_options.name","custom_field.enum_value","custom_field.enum_value.color","custom_field.enum_value.enabled","custom_field.enum_value.name","custom_field.id_prefix","custom_field.input_restrictions","custom_field.is_formula_field","custom_field.is_lookup_field","custom_field.multi_enum_values","custom_field.multi_enum_values.color","custom_field.multi_enum_values.enabled","custom_field.multi_enum_values.name","custom_field.name","custom_field.number_value","custom_field.representation_type","custom_field.text_value","custom_field.type","is_important","offset","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"table_gid": "1337"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a tag — asana.createtag
Required scope: tags:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","created_at","followers","followers.name","name","notes","permalink_url","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TagCreateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a tag — asana.gettag
Required scope: tags:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.tag_gid |
string | Required | Globally unique identifier for the tag. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","created_at","followers","followers.name","name","notes","permalink_url","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"tag_gid": "11235"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a tag — asana.updatetag
Required scope: tags:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.tag_gid |
string | Required | Globally unique identifier for the tag. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","created_at","followers","followers.name","name","notes","permalink_url","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TagUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"tag_gid": "11235"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a tag — asana.deletetag
A specific, existing tag can be deleted by making a DELETE request on the URL for that tag.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.tag_gid |
string | Required | Globally unique identifier for the tag. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"tag_gid": "11235"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a tag in a workspace — asana.createtagforworkspace
Required scope: tags:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","created_at","followers","followers.name","name","notes","permalink_url","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TagCreateTagForWorkspaceRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple task templates — asana.gettasktemplates
Required scope: task_templates:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.project |
string | Optional | The project to filter task templates on. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","created_by","name","offset","path","project","template","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a task template — asana.gettasktemplate
Required scope: task_templates:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_template_gid |
string | Required | Globally unique identifier for the task template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","created_by","name","project","template"] |
Full JSON Schema
Example input
{
"path": {
"task_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a task template — asana.deletetasktemplate
A specific, existing task template can be deleted by making a DELETE request on the URL for that task template. Returns an empty data record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_template_gid |
string | Required | Globally unique identifier for the task template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"task_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Instantiate a task from a task template — asana.instantiatetask
Creates and returns a job that will asynchronously handle the task instantiation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_template_gid |
string | Required | Globally unique identifier for the task template. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Optional | ||
body.data |
— | Optional | $ref: "#/definitions/TaskTemplateInstantiateTaskRequest" |
Full JSON Schema
Example input
{
"path": {
"task_template_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple tasks — asana.gettasks
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.assignee |
string | Optional | 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. |
|
query.project |
string | Optional | The project to filter tasks on. | |
query.section |
string | Optional | The section to filter tasks on. | |
query.workspace |
string | Optional | The workspace to filter tasks on. Note: If you specify workspace, you must also specify the assignee to filter on. |
|
query.completed_since |
string | Optional | Only return tasks that are either incomplete or that have been completed since this time. | format: "date-time" |
query.modified_since |
string | Optional | 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. | format: "date-time" |
query.custom_type |
string | Optional | Filter results by custom type. Provide a custom type GID to return only objects of that custom type (an unknown GID returns 400). Provide an empty string to return only objects with no custom type assigned. If this parameter is omitted, results are not filtered by custom type. |
|
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a task — asana.createtask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskCreateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a task — asana.gettask
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a task — asana.updatetask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a task — asana.deletetask
Required scope: tasks:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate a task — asana.duplicatetask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskDuplicateRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get tasks from a project — asana.gettasksforproject
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.completed_since |
string | Optional | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
|
path |
object | Required | additionalProperties: false |
|
path.project_gid |
string | Required | Globally unique identifier for the project. |
Full JSON Schema
Example input
{
"path": {
"project_gid": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get tasks from a section — asana.gettasksforsection
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.section_gid |
string | Required | The globally unique identifier for the section. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.completed_since |
string | Optional | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"section_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get tasks from a tag — asana.gettasksfortag
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.tag_gid |
string | Required | Globally unique identifier for the tag. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"tag_gid": "11235"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get tasks from a user task list — asana.gettasksforusertasklist
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.completed_since |
string | Optional | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
|
path |
object | Required | additionalProperties: false |
|
path.user_task_list_gid |
string | Required | Globally unique identifier for the user task list. |
Full JSON Schema
Example input
{
"path": {
"user_task_list_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get subtasks from a task — asana.getsubtasksfortask
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a subtask — asana.createsubtaskfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskCreateRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set the parent of a task — asana.setparentfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskSetParentRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get dependencies from a task — asana.getdependenciesfortask
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set dependencies for a task — asana.adddependenciesfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ModifyDependenciesRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Unlink dependencies from a task — asana.removedependenciesfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ModifyDependenciesRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get dependents from a task — asana.getdependentsfortask
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","offset","parent","parent.created_by","parent.name","parent.resource_subtype","path","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","uri","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set dependents for a task — asana.adddependentsfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ModifyDependentsRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Unlink dependents from a task — asana.removedependentsfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/ModifyDependentsRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a project to a task — asana.addprojectfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskAddProjectRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {
"data": {
"project": "13579",
"section": "987654"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a project from a task — asana.removeprojectfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskRemoveProjectRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a tag to a task — asana.addtagfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskAddTagRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a tag from a task — asana.removetagfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskRemoveTagRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add followers to a task — asana.addfollowersfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskAddFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove followers from a task — asana.removefollowerfortask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TaskRemoveFollowersRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Roll up subtask dates for a task — asana.rolluptask
Required scope: tasks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["dates_rollup_progress","dates_rollup_progress.total_tasks","dates_rollup_progress.updated_tasks","new_graph_export","new_graph_export.completed_at","new_graph_export.created_at","new_graph_export.download_url","new_portfolio","new_portfolio.name","new_portfolio.resource_subtype","new_project","new_project.name","new_project.resource_subtype","new_project_template","new_project_template.name","new_resource_export","new_resource_export.completed_at","new_resource_export.created_at","new_resource_export.download_url","new_task","new_task.created_by","new_task.name","new_task.resource_subtype","resource_subtype","status"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a task for a given custom ID — asana.gettaskforcustomid
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
path.custom_id |
string | Required | Generated custom ID for a task. |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345",
"custom_id": "EX-1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search tasks in a workspace — asana.searchtasksforworkspace
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per search response. The number of objects to return in one search response. The value must be between 1 and 100. Search responses have no next_page, so to retrieve further results, sort by created_at and repeat the query with a created_at.before or created_at.after filter that excludes the results you have already seen. |
minimum: 1; maximum: 100 |
query.text |
string | Optional | Performs full-text search on both task name and description | |
query.resource_subtype |
string | Optional | Filters results by the task's resource_subtype | enum: ["default_task","milestone","approval","custom"]; default: "milestone" |
query.assignee.any |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.assignee.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.portfolios.any |
string | Optional | Comma-separated list of portfolio IDs | |
query.projects.any |
string | Optional | Comma-separated list of project IDs. Returns tasks that are directly in these projects or inherit them from an ancestor task. | |
query.projects.not |
string | Optional | Comma-separated list of project IDs | |
query.projects.all |
string | Optional | Comma-separated list of project IDs | |
query.sections.any |
string | Optional | Comma-separated list of section or column IDs | |
query.sections.not |
string | Optional | Comma-separated list of section or column IDs | |
query.sections.all |
string | Optional | Comma-separated list of section or column IDs | |
query.tags.any |
string | Optional | Comma-separated list of tag IDs | |
query.tags.not |
string | Optional | Comma-separated list of tag IDs | |
query.tags.all |
string | Optional | Comma-separated list of tag IDs | |
query.teams.any |
string | Optional | Comma-separated list of team IDs | |
query.followers.any |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.followers.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.created_by.any |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.created_by.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.assigned_by.any |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.assigned_by.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.liked_by.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.commented_on_by.not |
string | Optional | Comma-separated list of user identifiers. This can either be the string "me", an email, or the gid of a user. | |
query.due_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.due_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.due_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.due_at.before |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.due_at.after |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.start_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.start_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.start_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.created_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.created_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.created_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.created_at.before |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.created_at.after |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.completed_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.completed_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.completed_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.completed_at.before |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.completed_at.after |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.modified_on.before |
string | Optional | ISO 8601 date string | format: "date" |
query.modified_on.after |
string | Optional | ISO 8601 date string | format: "date" |
query.modified_on |
string | null | Optional | ISO 8601 date string or null |
format: "date" |
query.modified_at.before |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.modified_at.after |
string | Optional | ISO 8601 datetime string | format: "date-time" |
query.is_blocking |
boolean | Optional | Filter to incomplete tasks with dependents | |
query.is_blocked |
boolean | Optional | Filter to tasks with incomplete dependencies | |
query.has_attachment |
boolean | Optional | Filter to tasks with attachments | |
query.completed |
boolean | Optional | Filter to completed tasks | |
query.is_subtask |
boolean | Optional | Filter to subtasks | |
query.sort_by |
string | Optional | One of due_date, created_at, completed_at, likes, relevance, or modified_at, defaults to modified_at |
enum: ["due_date","created_at","completed_at","likes","modified_at","relevance"]; default: "modified_at" |
query.sort_ascending |
boolean | Optional | Default false |
default: false |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["actual_time_minutes","approval_status","assigned_by","assigned_by.name","assignee","assignee.name","assignee_section","assignee_section.name","assignee_status","completed","completed_at","completed_by","completed_by.name","created_at","created_by","custom_fields","custom_fields.asana_created_field","custom_fields.created_by","custom_fields.created_by.name","custom_fields.currency_code","custom_fields.custom_label","custom_fields.custom_label_position","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.default_access_level","custom_fields.description","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.format","custom_fields.has_notifications_enabled","custom_fields.html_text_value","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_global_to_workspace","custom_fields.is_lookup_field","custom_fields.is_value_read_only","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.people_value","custom_fields.people_value.name","custom_fields.precision","custom_fields.privacy_setting","custom_fields.reference_value","custom_fields.reference_value.name","custom_fields.representation_type","custom_fields.resource_subtype","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","custom_type_status_option","custom_type_status_option.name","dependencies","dependents","due_at","due_on","effective_memberships","external","external.data","followers","followers.name","has_subtasks_date_mismatch","hearted","hearts","hearts.user","hearts.user.name","html_notes","is_rendered_as_separator","liked","likes","likes.user","likes.user.name","memberships","memberships.project","memberships.project.name","memberships.project.resource_subtype","memberships.section","memberships.section.name","modified_at","name","notes","num_hearts","num_likes","num_subtasks","parent","parent.created_by","parent.name","parent.resource_subtype","permalink_url","projects","projects.name","projects.resource_subtype","resource_subtype","start_at","start_on","tags","tags.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a team membership — asana.getteammembership
Required scope: team_memberships:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_membership_gid |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["is_admin","is_guest","is_limited_access","team","team.name","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"team_membership_gid": "724362"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get team memberships — asana.getteammemberships
Required scope: team_memberships:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.team |
string | Optional | Globally unique identifier for the team. | |
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. This parameter must be used with the workspace parameter. | |
query.workspace |
string | Optional | Globally unique identifier for the workspace. This parameter must be used with the user parameter. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["is_admin","is_guest","is_limited_access","offset","path","team","team.name","uri","user","user.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get memberships from a team — asana.getteammembershipsforteam
Required scope: team_memberships:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["is_admin","is_guest","is_limited_access","offset","path","team","team.name","uri","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get memberships from a user — asana.getteammembershipsforuser
Required scope: team_memberships:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.workspace |
string | Required | Globally unique identifier for the workspace. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["is_admin","is_guest","is_limited_access","offset","path","team","team.name","uri","user","user.name"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"query": {
"workspace": "31326"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a team — asana.createteam
Creates a team within the current workspace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","description","edit_team_name_or_description_access_level","edit_team_visibility_or_trash_team_access_level","endorsed","guest_invite_management_access_level","html_description","join_request_management_access_level","member_invite_management_access_level","name","organization","organization.name","permalink_url","team_content_management_access_level","team_member_removal_access_level","visibility"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TeamRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a team — asana.getteam
Required scope: teams:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","description","edit_team_name_or_description_access_level","edit_team_visibility_or_trash_team_access_level","endorsed","guest_invite_management_access_level","html_description","join_request_management_access_level","member_invite_management_access_level","name","organization","organization.name","permalink_url","team_content_management_access_level","team_member_removal_access_level","visibility"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a team — asana.updateteam
Updates a team within the current workspace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","description","edit_team_name_or_description_access_level","edit_team_visibility_or_trash_team_access_level","endorsed","guest_invite_management_access_level","html_description","join_request_management_access_level","member_invite_management_access_level","name","organization","organization.name","permalink_url","team_content_management_access_level","team_member_removal_access_level","visibility"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TeamRequest" |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get teams in a workspace — asana.getteamsforworkspace
Required scope: teams:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","description","edit_team_name_or_description_access_level","edit_team_visibility_or_trash_team_access_level","endorsed","guest_invite_management_access_level","html_description","join_request_management_access_level","member_invite_management_access_level","name","offset","organization","organization.name","path","permalink_url","team_content_management_access_level","team_member_removal_access_level","uri","visibility"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get teams for a user — asana.getteamsforuser
Required scope: teams:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.organization |
string | Required | The workspace or organization to filter teams on. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","description","edit_team_name_or_description_access_level","edit_team_visibility_or_trash_team_access_level","endorsed","guest_invite_management_access_level","html_description","join_request_management_access_level","member_invite_management_access_level","name","offset","organization","organization.name","path","permalink_url","team_content_management_access_level","team_member_removal_access_level","uri","visibility"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"query": {
"organization": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a user to a team — asana.adduserforteam
The user making this call must be a member of the team in order to add others. The user being added must exist in the same organization as the team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["is_admin","is_guest","is_limited_access","team","team.name","user","user.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TeamAddUserRequest" |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a user from a team — asana.removeuserforteam
The user making this call must be a member of the team in order to remove themselves or others.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TeamRemoveUserRequest" |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a time period — asana.gettimeperiod
Returns the full record for a single time period.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_period_gid |
string | Required | Globally unique identifier for the time period. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["display_name","end_on","parent","parent.display_name","parent.end_on","parent.period","parent.start_on","period","start_on"] |
Full JSON Schema
Example input
{
"path": {
"time_period_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get time periods — asana.gettimeperiods
Returns compact time period records.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.start_on |
string | Optional | ISO 8601 date string | format: "date" |
query.end_on |
string | Optional | ISO 8601 date string | format: "date" |
query.workspace |
string | Required | Globally unique identifier for the workspace. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["display_name","end_on","offset","parent","parent.display_name","parent.end_on","parent.period","parent.start_on","path","period","start_on","uri"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "31326"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a time tracking category — asana.gettimetrackingcategory
Required scope: time_tracking_categories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_category_gid |
string | Required | Globally unique identifier for the time tracking category. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","is_archived","name"] |
Full JSON Schema
Example input
{
"path": {
"time_tracking_category_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a time tracking category — asana.updatetimetrackingcategory
Required scope: time_tracking_categories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_category_gid |
string | Required | Globally unique identifier for the time tracking category. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","is_archived","name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TimeTrackingCategoryUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"time_tracking_category_gid": "917392"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a time tracking category — asana.deletetimetrackingcategory
Required scope: time_tracking_categories:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_category_gid |
string | Required | Globally unique identifier for the time tracking category. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"time_tracking_category_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get time tracking entries for a time tracking category — asana.gettimetrackingentriesfortimetrackingcategory
Required scope: time_tracking_categories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_category_gid |
string | Required | Globally unique identifier for the time tracking category. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.start_date |
string | Optional | The start date for filtering time tracking entries by their entry date. | format: "date" |
query.end_date |
string | Optional | The end date for filtering time tracking entries by their entry date. | format: "date" |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","categories","categories.color","categories.name","created_by","created_by.name","duration_minutes","entered_on","offset","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"time_tracking_category_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get time tracking categories for a workspace — asana.gettimetrackingcategories
Required scope: time_tracking_categories:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Required | Globally unique identifier for the workspace. | |
query.is_archived |
boolean | Optional | Filter by archived status. If not provided, defaults to returning non-archived categories. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","is_archived","name","offset","path","uri"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a time tracking category — asana.createtimetrackingcategory
Required scope: time_tracking_categories:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["color","is_archived","name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/TimeTrackingCategoryCreateRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get time tracking entries for a task — asana.gettimetrackingentriesfortask
Required scope: time_tracking_entries:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","categories","categories.color","categories.name","created_by","created_by.name","duration_minutes","entered_on","offset","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a time tracking entry — asana.createtimetrackingentry
Creates a time tracking entry on a given task.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.task_gid |
string | Required | The task to operate on. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","billable_status","categories","categories.color","categories.name","created_at","created_by","created_by.name","description","duration_minutes","entered_on","task","task.created_by","task.name","task.resource_subtype"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/CreateTimeTrackingEntryRequest" |
Full JSON Schema
Example input
{
"path": {
"task_gid": "321654"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a time tracking entry — asana.gettimetrackingentry
Required scope: time_tracking_entries:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_entry_gid |
string | Required | Globally unique identifier for the time tracking entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","billable_status","categories","categories.color","categories.name","created_at","created_by","created_by.name","description","duration_minutes","entered_on","task","task.created_by","task.name","task.resource_subtype"] |
Full JSON Schema
Example input
{
"path": {
"time_tracking_entry_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a time tracking entry — asana.updatetimetrackingentry
A specific, existing time tracking entry can be updated by making a PUT request on the URL for that time tracking entry. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_entry_gid |
string | Required | Globally unique identifier for the time tracking entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","billable_status","categories","categories.color","categories.name","created_at","created_by","created_by.name","description","duration_minutes","entered_on","task","task.created_by","task.name","task.resource_subtype"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/UpdateTimeTrackingEntryRequest" |
Full JSON Schema
Example input
{
"path": {
"time_tracking_entry_gid": "917392"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a time tracking entry — asana.deletetimetrackingentry
A specific, existing time tracking entry can be deleted by making a DELETE request on the URL for that time tracking entry.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.time_tracking_entry_gid |
string | Required | Globally unique identifier for the time tracking entry. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"time_tracking_entry_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple time tracking entries — asana.gettimetrackingentries
Required scope: time_tracking_entries:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.task |
string | Optional | Globally unique identifier for the task to filter time tracking entries by. | |
query.attributable_to |
string | Optional | Globally unique identifier for the project the time tracking entries are attributed to. | |
query.portfolio |
string | Optional | Globally unique identifier for the portfolio to filter time tracking entries by. | |
query.user |
string | Optional | Deprecated - please use assignee instead Globally unique identifier for the user the time tracking entry's logged time is attributed to, to filter time tracking entries by. | |
query.assignee |
string | Optional | Globally unique identifier for the user the time tracking entry's logged time is attributed to, to filter time tracking entries by. | |
query.workspace |
string | Optional | Globally unique identifier for the workspace. At least one of entered_on_start_date or entered_on_end_date must be provided when filtering by workspace. |
|
query.entered_on_start_date |
string | Optional | The start date for filtering time tracking entries by when they were entered. | format: "date" |
query.entered_on_end_date |
string | Optional | The end date for filtering time tracking entries by when they were entered. | format: "date" |
query.timesheet_approval_status |
string | Optional | Globally unique identifier for the timesheet approval status to filter time tracking entries by. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["assignee","assignee.name","attributable_to","attributable_to.name","attributable_to.resource_subtype","categories","categories.color","categories.name","created_by","created_by.name","duration_minutes","entered_on","offset","path","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a timesheet approval status — asana.gettimesheetapprovalstatus
Required scope: timesheet_approval_statuses:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.timesheet_approval_status_gid |
string | Required | Globally unique identifier for the timesheet approval status. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","created_at","end_date","start_date","user","user.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"timesheet_approval_status_gid": "917392"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a timesheet approval status — asana.updatetimesheetapprovalstatus
Required scope: timesheet_approval_statuses:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.timesheet_approval_status_gid |
string | Required | Globally unique identifier for the timesheet approval status. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","created_at","end_date","start_date","user","user.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/UpdateTimesheetApprovalStatusRequest" |
Full JSON Schema
Example input
{
"path": {
"timesheet_approval_status_gid": "917392"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple timesheet approval statuses — asana.gettimesheetapprovalstatuses
Required scope: timesheet_approval_statuses:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Required | Globally unique identifier for the workspace. | |
query.user |
string | Optional | Globally unique identifier for the user to filter timesheet approval statuses by. | |
query.from_date |
string | Optional | The start date for filtering timesheet approval statuses. | format: "date" |
query.to_date |
string | Optional | The end date for filtering timesheet approval statuses. | format: "date" |
query.approval_statuses |
string | Optional | Filter by approval status. Can be one or more of draft, submitted, approved, or rejected. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","created_at","end_date","offset","path","start_date","uri","user","user.name","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a timesheet approval status — asana.createtimesheetapprovalstatus
Required scope: timesheet_approval_statuses:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["approval_status","created_at","end_date","start_date","user","user.name","workspace","workspace.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/CreateTimesheetApprovalStatusRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get objects via typeahead — asana.typeaheadforworkspace
Required scope: workspaces.typeahead:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Required | additionalProperties: false |
|
query.resource_type |
string | Required | The type of values the typeahead should return. You can choose from one of the following: actor, agent, custom_field, goal, project, project_template, portfolio, tag, task, team, and user. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. task). Using multiple types is not yet supported. The agent type returns only agents, currently limited to AI Teammates, which are Asana's first-party agents. The actor type returns a combined set of users and agents. |
enum: ["actor","agent","custom_field","goal","project","project_template","portfolio","tag","task","team","user"]; default: "user" |
query.type |
string | Optional | Deprecated: new integrations should prefer the resource_type field. | enum: ["custom_field","portfolio","project","tag","task","user"]; default: "user" |
query.query |
string | Optional | The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results. | |
query.count |
integer | Optional | The number of results to return. The default is 20 if this parameter is omitted, with a minimum of 1 and a maximum of 100. If there are fewer results found than requested, all will be returned. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"query": {
"resource_type": "user"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a user task list — asana.getusertasklist
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_task_list_gid |
string | Required | Globally unique identifier for the user task list. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["name","owner","workspace"] |
Full JSON Schema
Example input
{
"path": {
"user_task_list_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a user's task list — asana.getusertasklistforuser
Required scope: tasks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Required | The workspace in which to get the user task list. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["name","owner","workspace"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"query": {
"workspace": "1234"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple users — asana.getusers
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.workspace |
string | Optional | The workspace or organization ID to filter users on. | |
query.team |
string | Optional | The team ID to filter users on. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","offset","path","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","uri","workspaces","workspaces.name"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a user — asana.getuser
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Optional | The workspace to filter results on. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a user — asana.updateuser
A specific, existing user can be updated by making a PUT request on the URL for that user. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.workspace |
string | Optional | The workspace to filter results on. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/UserUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a user's favorites — asana.getfavoritesforuser
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.resource_type |
string | Required | The resource type of favorites to be returned. | enum: ["portfolio","project","tag","task","user","project_template"]; default: "project" |
query.workspace |
string | Required | The workspace in which to get favorites. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["name","offset","path","uri"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
},
"query": {
"resource_type": "project",
"workspace": "1234"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get users in a team — asana.getusersforteam
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.team_gid |
string | Required | Globally unique identifier for the team. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
Full JSON Schema
Example input
{
"path": {
"team_gid": "159874"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get users in a workspace or organization — asana.getusersforworkspace
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a user in a workspace or organization — asana.getuserforworkspace
Required scope: users:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345",
"user_gid": "me"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a user in a workspace or organization — asana.updateuserforworkspace
An existing user can be updated by making a PUT request on the URL for that user in the specified workspace or organization. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60","workspaces","workspaces.name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/UserUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345",
"user_gid": "me"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple webhooks — asana.getwebhooks
Required scope: webhooks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.workspace |
string | Required | The workspace to query for webhooks in. | |
query.resource |
string | Optional | Only return webhooks for the given resource. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["active","created_at","delivery_retry_count","failure_deletion_timestamp","filters","filters.action","filters.fields","filters.resource_subtype","last_failure_at","last_failure_content","last_success_at","next_attempt_after","offset","path","resource","resource.name","target","uri"] |
Full JSON Schema
Example input
{
"query": {
"workspace": "1331"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Establish a webhook — asana.createwebhook
Required scope: webhooks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["active","created_at","delivery_retry_count","failure_deletion_timestamp","filters","filters.action","filters.fields","filters.resource_subtype","last_failure_at","last_failure_content","last_success_at","next_attempt_after","resource","resource.name","target"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/WebhookRequest" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a webhook — asana.getwebhook
Required scope: webhooks:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_gid |
string | Required | Globally unique identifier for the webhook. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["active","created_at","delivery_retry_count","failure_deletion_timestamp","filters","filters.action","filters.fields","filters.resource_subtype","last_failure_at","last_failure_content","last_success_at","next_attempt_after","resource","resource.name","target"] |
Full JSON Schema
Example input
{
"path": {
"webhook_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a webhook — asana.updatewebhook
Required scope: webhooks:write
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_gid |
string | Required | Globally unique identifier for the webhook. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["active","created_at","delivery_retry_count","failure_deletion_timestamp","filters","filters.action","filters.fields","filters.resource_subtype","last_failure_at","last_failure_content","last_success_at","next_attempt_after","resource","resource.name","target"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/WebhookUpdateRequest" |
Full JSON Schema
Example input
{
"path": {
"webhook_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a webhook — asana.deletewebhook
Required scope: webhooks:delete
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.webhook_gid |
string | Required | Globally unique identifier for the webhook. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. |
Full JSON Schema
Example input
{
"path": {
"webhook_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a workspace membership — asana.getworkspacemembership
Returns the complete workspace record for a single workspace membership.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_membership_gid |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_active","is_admin","is_guest","is_view_only","user","user.name","user_task_list","user_task_list.name","user_task_list.owner","user_task_list.workspace","vacation_dates","vacation_dates.end_on","vacation_dates.start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_membership_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get workspace memberships for a user — asana.getworkspacemembershipsforuser
Returns the compact workspace membership records for the user.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_gid |
string | Required | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_active","is_admin","is_guest","is_view_only","offset","path","uri","user","user.name","user_task_list","user_task_list.name","user_task_list.owner","user_task_list.workspace","vacation_dates","vacation_dates.end_on","vacation_dates.start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"user_gid": "me"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the workspace memberships for a workspace — asana.getworkspacemembershipsforworkspace
Returns the compact workspace membership records for the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.user |
string | Optional | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | |
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["created_at","is_active","is_admin","is_guest","is_view_only","offset","path","uri","user","user.name","user_task_list","user_task_list.name","user_task_list.owner","user_task_list.workspace","vacation_dates","vacation_dates.end_on","vacation_dates.start_on","workspace","workspace.name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get multiple workspaces — asana.getworkspaces
Required scope: workspaces:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.limit |
integer | Optional | Results per page. The number of objects to return per page. The value must be between 1 and 100. | minimum: 1; maximum: 100 |
query.offset |
string | Optional | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["email_domains","is_organization","name","offset","path","uri"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a workspace — asana.getworkspace
Required scope: workspaces:read
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["email_domains","is_organization","name"] |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a workspace — asana.updateworkspace
A specific, existing workspace can be updated by making a PUT request on the URL for that workspace. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. Currently the only field that can be modified for a workspace is its name. Returns the complete, updated workspace record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["email_domains","is_organization","name"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/WorkspaceRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a user to a workspace or organization — asana.adduserforworkspace
Add a user to a workspace or organization. The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.opt_fields |
array | Optional | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide. | |
query.opt_fields[] |
string | Optional | enum: ["email","name","photo","photo.image_1024x1024","photo.image_128x128","photo.image_21x21","photo.image_27x27","photo.image_36x36","photo.image_60x60"] |
|
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/WorkspaceAddUserRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a user from a workspace or organization — asana.removeuserforworkspace
Remove a user from a workspace or organization.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
body |
object | Required | ||
body.data |
— | Optional | $ref: "#/definitions/WorkspaceRemoveUserRequest" |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get workspace events — asana.getworkspaceevents
Returns the full record for all events that have occurred since the sync token was created. The response is a list of events and the schema of each event is as described here. Asana limits a single sync token to 1000 events. If more than 1000 events exist for a given domain, has_more: true will be returned in the response, indicating that there are more events to pull.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_gid |
string | Required | Globally unique identifier for the workspace or organization. | |
query |
object | Optional | additionalProperties: false |
|
query.opt_pretty |
boolean | Optional | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | |
query.sync |
string | Optional | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token. If the sync token is too old (which may happen from time to time) the API will return a 412 Precondition Failed error, and include a fresh sync token in the response. |
Full JSON Schema
Example input
{
"path": {
"workspace_gid": "12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.