While you can jump into the API reference documentation and start coding in favorite IDE, here are some tools that make it easier to get started:
After you’ve gathered requirements and scoped your app, it’s time to start building. The first step is going to the developer console (which is called “My apps”) where you can create an OAuth app or generate a PAT in order to auth your first API request.
Asana's REST API reference allows you to explore different REST API endpoints through an in-context, easy-to-use interface. Using this built-in API explorer, you can make API requests (and view responses) directly in your browser.
For more details, see the documentation for the API explorer.
Asana has client libraries in a handful of languages that make it quicker and easier to get started building apps with the API. The libraries abstract some of the more challenging aspects of development such as authentication and pagination. There are code examples for each library to help you get started.
The client libraries also help developers navigate API deprecations, which will help you avoid unexpected breaking changes and reduce the overall time required for maintenance.
Note that most client library functions are not documented. You need to check the
lib/resources/gen folder of each library to see the built-in functions.
If you’re familiar with Postman or just prefer making API requests from your machine instead of the browser, you can use our Postman Collection to interface with our API.
In some cases, it can be helpful to use an Asana sandbox environment when developing custom apps. For example, if you’re making admin or domain-level API write requests, you may not want to use your company’s production Asana account to avoid making unintended changes to your domain.
If you want to see more guides and example scripts/apps, you can find links in the code examples section of this documentation site.
Updated 8 months ago