The Asana API explorer is a tool to easily make API requests in your browser and quickly test various routes, fields, and parameters.
The explorer is not meant to be an exhaustive tool with every endpoint in the API. Instead, the API explorer is designed to be a simple tool to help developers quickly access the API and see examples of requests and responses fetching real Asana data. You should use the Postman Collection if you prefer a tool with complete coverage.
To get started, follow these steps:
-
Visit the API explorer site: https://developers.asana.com/explorer
-
Click the large button that says Click to authorize API Explorer. This will use your Asana credentials to provide cookie authentication for the requests you make in the explorer. Because the explorer uses your Asana account, it only allows read requests (i.e.,
GET) to protect against unintentionally changing your Asana data. -
Choose the resource you wish to query from the drop-down.
-
In the next drop-down, choose your desired route for that resource.
-
Under Include Fields, you have the option to select only the fields you would like to include in the response (see more about input/output options).
-
The default response limit is 10. You can increase it up to 100.
-
Add the required Attribute parameters. Note that task and project gids are in URLs when viewing those resources in the Asana web product (e.g., when viewing a task in a project: https://app.asana.com/0/'project-gid'/'task-gid').
-
In subsequent requests, you may have a pagination token to paste into the Offset field.
-
You have the option to include additional parameters in your request.
-
Click Submit to send your request to the API. You will receive a JSON pretty-formatted response.