{"@context": "https://schema.org", "@type": "WebAPI", "name": "Asana API", "description": "This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml).", "provider": {"@type": "Organization", "name": "asana.com"}, "documentation": "https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml"}
This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml).
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://app.asana.com/api/1.0
auth: b e a r ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml).
| method | path | what the vendor says it does |
|---|---|---|
GET | /attachments | Get attachments from an object Returns the compact records for all attachments on the object. There are three |
POST | /attachments | Upload an attachment Upload an attachment. This method uploads an attachment on an object and returns the com |
GET | /attachments/{attachment_gid} | Get an attachment Get the full record for a single attachment. Attachments |
DELETE | /attachments/{attachment_gid} | Delete an attachment Deletes a specific, existing attachment. Returns an empty data record. Attachments |
POST | /batch | Submit parallel requests Make multiple requests in parallel to Asana's API. Batch API |
POST | /custom_fields | Create a custom field Creates a new custom field in a workspace. Every custom field is required to be created |
GET | /custom_fields/{custom_field_gid} | Get a custom field Get the complete definition of a custom field’s metadata. Since custom fields can be defin |
PUT | /custom_fields/{custom_field_gid} | Update a custom field A specific, existing custom field can be updated by making a PUT request on the URL for |
DELETE | /custom_fields/{custom_field_gid} | Delete a custom field A specific, existing custom field can be deleted by making a DELETE request on the URL f |
POST | /custom_fields/{custom_field_gid}/enum_options | Create an enum option Creates an enum option and adds it to this custom field’s list of enum options. A custom |
POST | /custom_fields/{custom_field_gid}/enum_options/insert | Reorder a custom field's enum Moves a particular enum option to be either before or after another specified en |
PUT | /enum_options/{enum_option_gid} | Update an enum option Updates an existing enum option. Enum custom fields require at least one enabled enum op |
GET | /events | Get events on a resource Returns the full record for all events that have occurred since the sync token was cr |
GET | /goal_relationships | Get goal relationships Returns compact goal relationship records. Goal relationships |
GET | /goal_relationships/{goal_relationship_gid} | Get a goal relationship Returns the complete updated goal relationship record for a single goal relationship. |
PUT | /goal_relationships/{goal_relationship_gid} | Update a goal relationship An existing goal relationship can be updated by making a PUT request on the URL for |
GET | /goals | Get goals Returns compact goal records. Goals |
POST | /goals | Create a goal Creates a new goal in a workspace or team. Returns the full record of the newly created goal. G |
GET | /goals/{goal_gid} | Get a goal Returns the complete goal record for a single goal. Goals |
PUT | /goals/{goal_gid} | Update a goal An existing goal can be updated by making a PUT request on the URL for that goal. Only the field |
DELETE | /goals/{goal_gid} | Delete a goal A specific, existing goal can be deleted by making a DELETE request on the URL for that goal. R |
POST | /goals/{goal_gid}/addFollowers | Add a collaborator to a goal Adds followers to a goal. Returns the goal the followers were added to. Each goal |
POST | /goals/{goal_gid}/addSupportingRelationship | Add a supporting goal relationship Creates a goal relationship by adding a supporting resource to a given goal |
GET | /goals/{goal_gid}/parentGoals | Get parent goals from a goal Returns a compact representation of all of the parent goals of a goal. Goals |
POST | /goals/{goal_gid}/removeFollowers | Remove a collaborator from a goal Removes followers from a goal. Returns the goal the followers were removed f |
POST | /goals/{goal_gid}/removeSupportingRelationship | Removes a supporting goal relationship Removes a goal relationship for a given parent goal. Goal relationships |
POST | /goals/{goal_gid}/setMetric | Create a goal metric Creates and adds a goal metric to a specified goal. Note that this replaces an existing g |
POST | /goals/{goal_gid}/setMetricCurrentValue | Update a goal metric Updates a goal's existing metric's `current_number_value` if one exists, otherwise respon |
GET | /jobs/{job_gid} | Get a job by id Returns the full record for a job. Jobs |
POST | /organization_exports | Create an organization export request This method creates a request to export an Organization. Asana will comp |
GET | /organization_exports/{organization_export_gid} | Get details on an org export request Returns details of a previously-requested Organization export. Organizati |
GET | /portfolio_memberships | Get multiple portfolio memberships Returns a list of portfolio memberships in compact representation. You must |
GET | /portfolio_memberships/{portfolio_membership_gid} | Get a portfolio membership Returns the complete portfolio record for a single portfolio membership. Portfolio |
GET | /portfolios | Get multiple portfolios Returns a list of the portfolios in compact representation that are owned by the curre |
POST | /portfolios | Create a portfolio Creates a new portfolio in the given workspace with the supplied name. Note that portfolio |
GET | /portfolios/{portfolio_gid} | Get a portfolio Returns the complete portfolio record for a single portfolio. Portfolios |
PUT | /portfolios/{portfolio_gid} | Update a portfolio An existing portfolio can be updated by making a PUT request on the URL for that portfolio. |
DELETE | /portfolios/{portfolio_gid} | Delete a portfolio An existing portfolio can be deleted by making a DELETE request on the URL for that portfol |
POST | /portfolios/{portfolio_gid}/addCustomFieldSetting | Add a custom field to a portfolio Custom fields are associated with portfolios by way of custom field settings |
POST | /portfolios/{portfolio_gid}/addItem | Add a portfolio item Add an item to a portfolio. Returns an empty data block. Portfolios |
and 127 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.