• Installs:
  • Today: 41
  • This Week: 205
  • This Month: 697
  • All Time: 1964
Developer:userzakutynsky

Asana API Package

Customize the Asana experience, leverage your data with the Asana.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Asana

Asana Package

Customize the Asana experience, leverage your data with the Asana API, and join a community of developers building with Asana.

  • Domain: asana.com
  • Credentials: accessToken

How to get credentials:

  1. Navigate to Asana apps page
  2. Create new app.
  3. Create New Personal Access Token

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Webhook credentials

Please use SDK to test this feature.

  1. Go to RapidAPI
  2. Log in or create an account
  3. Go to My apps
  4. Add new project with projectName to get your project Key
FieldTypeDescription
projectNamecredentialsYour RapidAPI project name
projectKeycredentialsYour RapidAPI project key

Asana.getSingleAttachment

Returns the full record for a single attachment.

FieldTypeDescription
accessTokencredentialsYour access token.
attachmentIdStringGlobally unique identifier for the attachment.

Asana.getAttachmentsOnTask

Returns the compact records for all attachments on the task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskIdStringGlobally unique identifier for the task.

Asana.uploadAttachmentToTask

Returns the compact records for all attachments on the task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskIdStringGlobally unique identifier for the task.
fileFileUploaded file

Asana.getProjectCustomFieldsSettings

Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, opt_fields and opt_expand can be used to include more data than is returned in the compact representation. See the getting started guide on input/output options for more information.

FieldTypeDescription
accessTokencredentialsYour access token.
projectIdStringThe ID of the project for which to list custom field settings.

Asana.getCustomField

Returns the complete definition of a custom field’s metadata.

FieldTypeDescription
accessTokencredentialsYour access token.
fieldIdStringGlobally unique identifier for the custom field.

Asana.getAllCustomFields

Returns a list of the compact representation of all of the custom fields in a workspace.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace or organization to find custom field definitions in.

Asana.getEvents

Returns the full record for all events that have occurred since the sync token was created.

FieldTypeDescription
accessTokencredentialsYour access token.
projectIdStringA resource ID to subscribe to. The resource can be a task or project.
taskIdStringA resource ID to subscribe to. The resource can be a task or project.
syncStringA 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.

Asana.createProject

Creates a new project in a workspace or team.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace or organization to create the project in.
teamStringIf creating in an organization, the specific team to create the project in.
nameStringName of the project
notesStringProject notes

Asana.getSingleProject

Returns the complete project record for a single project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to get.

Asana.updateProject

A specific, existing project can be updated. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to get.
nameStringName of the project
notesStringProject notes

Asana.deleteProject

A specific, existing project can be deleted by making a DELETE request on the URL for that project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to delete.

Asana.queryProjects

Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned.

FieldTypeDescription
accessTokencredentialsYour access token.
archivedStringOnly return projects whose archived field takes on the value of this parameter.

Asana.getProjectTasks

Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project in which to search for tasks.

Asana.createProjectCustomFieldSetting

Create a new custom field setting on the project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to associate the custom field with.
customFieldStringThe id of the custom field to associate with this project.
isImportantStringWhether this field should be considered important to this project.
insertBeforeStringAn id of a Custom Field Settings on this project, before which the new Custom Field Settings will be added. insert_before and insert_after parameters cannot both be specified.
insertAfterStringAn id of a Custom Field Settings on this project, after which the new Custom Field Settings will be added. insert_before and insert_after parameters cannot both be specified.

Asana.createSection

Creates a new section in a project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to associate the custom field with.
nameStringThe text to be displayed as the section name. This cannot be an empty string..

Asana.getProjectSections

Returns the compact records for all sections in the specified project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectStringThe project to associate the custom field with.

Asana.getSingleSection

Returns the complete record for a single section.

FieldTypeDescription
accessTokencredentialsYour access token.
sectionStringThe section to get.

Asana.updateSection

When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.

FieldTypeDescription
accessTokencredentialsYour access token.
sectionStringThe section to update.
nameStringSection name.

Asana.deleteSection

Note that sections must be empty to be deleted.

FieldTypeDescription
accessTokencredentialsYour access token.
sectionStringThe section to delete.

Asana.reorderSections

At this point in time, moving sections is not supported in list views, only board views.

FieldTypeDescription
accessTokencredentialsYour access token.
sectionStringThe section to delete.
beforeSectionStringInsert the given section immediately before the section specified by this parameter.
afterSectionStringInsert the given section immediately before the section specified by this parameter.

Asana.getTaskStories

Returns the compact records for all stories on the task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringGlobally unique identifier for the task.

Asana.getSingleStory

Returns the full record for a single story.

FieldTypeDescription
accessTokencredentialsYour access token.
storyStringGlobally unique identifier for the story.

Asana.addCommentToTask

Adds a comment to a task. The comment will be authored by the currently authenticated user, and timestamped when the server receives the request.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringGlobally unique identifier for the task.
textStringThe plain text of the comment to add.

Asana.createTag

Creates a new tag in a workspace or organization.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace or organization to create the tag in.
tagStringTag name

Asana.getSingleTag

Returns the complete tag record for a single tag.

FieldTypeDescription
accessTokencredentialsYour access token.
tagStringThe tag to get.

Asana.updateTag

Updates the properties of a tag. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.

FieldTypeDescription
accessTokencredentialsYour access token.
tagStringThe tag to update.
nameStringTag name.

Asana.queryTags

Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.

FieldTypeDescription
accessTokencredentialsYour access token.
archivedBooleanOnly return tags whose archived field takes on the value of this parameter.

Asana.getTasksByTag

Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time.

FieldTypeDescription
accessTokencredentialsYour access token.
tagStringThe tag to fetch tasks from.

Asana.createTask

Creating a new task.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace to create a task in.
nameStringName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
followersListList of users following this task.
assigneeStringUser to which this task is assigned, or null if the task is unassigned.
notesStringMore detailed, free-form textual information associated with the task.

Asana.getTask

Returns the complete task record for a single task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to get.

Asana.updateTask

Existing task can be updated.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to update.
nameStringName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
assigneeStringUser to which this task is assigned, or null if the task is unassigned.
notesStringMore detailed, free-form textual information associated with the task.

Asana.deleteTask

Deleted tasks go into the “trash” of the user making the delete request. Tasks can be recovered from the trash within a period of 30 days; afterward they are completely removed from the system.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to delete.

Asana.queryTasks

Returns the compact task records for all tasks within the given project, ordered by their priority within the project.

FieldTypeDescription
accessTokencredentialsYour access token.
projectIdStringThe project in which to search for tasks.

Asana.createSubtask

Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to add a subtask to.
nameStringName of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
followersListList of users following this task.
assigneeStringUser to which this task is assigned, or null if the task is unassigned.
notesStringMore detailed, free-form textual information associated with the task.

Asana.getProjectsByTask

Returns a compact representation of all of the projects the task is in.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringGlobally unique identifier for the task.

Asana.addTaskToProject

Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to add to a project.
projectStringThe project to add the task to.
insertAfterStringA task in the project to insert the task after, or null to insert at the beginning of the list.
insertBeforeStringA task in the project to insert the task before, or null to insert at the end of the list.
sectionStringA section in the project to insert the task into. The task will be inserted at the bottom of the section.

Asana.removeTaskFromProject

Removes the task from the specified project. The task will still exist in the system, but it will not be in the project anymore.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to remove from a project.
projectStringThe project to remove the task from.

Asana.getTaskTags

Returns a compact representation of all of the tags the task has.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to get tags on.

Asana.addTagToTask

Adds a tag to a task. Returns an empty data block.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to add a tag to.
tagStringThe tag to add to the task.

Asana.removeTagFromTask

Removes a tag from the task. Returns an empty data block.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to remove a tag from.
tagStringThe tag to remove from the task.

Asana.addFollowersToTask

Adds each of the specified followers to the task, if they are not already following. Returns the complete, updated record for the affected task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to add followers to.
followersListList of followers to add to the task.

Asana.removeFollowersFromTask

Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task.

FieldTypeDescription
accessTokencredentialsYour access token.
taskStringThe task to remove followers from.
followersListList of followers to add to the task.

Asana.getOrganizationSingleTeam

Returns the full record for a single team.

FieldTypeDescription
accessTokencredentialsYour access token.
teamStringGlobally unique identifier for the team.

Asana.getOrganizationTeams

Returns the full record for a single team.

FieldTypeDescription
accessTokencredentialsYour access token.
organizationStringGlobally unique identifier for the workspace or organization.

Asana.getTeamsUserAssignedTo

Returns the compact records for all teams to which user is assigned.

FieldTypeDescription
accessTokencredentialsYour access token.
userIdStringGlobally unique identifier for the team.

Asana.getTeamMembersUsers

Returns the compact records for all users that are members of the team.

FieldTypeDescription
accessTokencredentialsYour access token.
teamStringGlobally unique identifier for the team.

Asana.addUserToTeam

The user making this call must be a member of the team in order to add others.

FieldTypeDescription
accessTokencredentialsYour access token.
teamStringGlobally unique identifier for the team.
userStringAn identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword me to indicate the current user making the request.

Asana.removeUserFromTeam

The user to remove can be referenced by their globally unique user ID or their email address. Removes the user from the specified team. Returns an empty data record.

FieldTypeDescription
accessTokencredentialsYour access token.
teamStringGlobally unique identifier for the team.
userStringAn identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword me to indicate the current user making the request.

Asana.queryTypeahead

This method returns typeahead search results.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringWorkspace id
queryStringThe value to look up. This is a string that will be used to search for relevant objects. If an empty string is passed in, the API will currently return an empty set.
typeStringThe type of object to look up. You can choose from one of the following: project, user, task, and tag. Note that unlike other endpoints, the types listed here are in singular form. Using multiple types is not yet supported.
countNumberThe 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.

Asana.getSingleUser

Returns the full user record for the single user with the provided ID.

FieldTypeDescription
accessTokencredentialsYour access token.
userStringAn identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword me to indicate the current user making the request.

Asana.getUsers

Returns the user records for all users in the specified workspace or organization.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace in which to get users.

Asana.createWebhook

Establishing a webhook is a two-part process. First, a simple HTTP POST similar to any other resource creation. Since you could have multiple webhooks we recommend specifying a unique local id for each target.

FieldTypeDescription
accessTokencredentialsYour access token.
resourceStringA resource ID to subscribe to. The resource can be a task or project.
targetStringThe URL to receive the HTTP POST.

Asana.getWebhooks

Returns the compact representation of all webhooks your app has registered for the authenticated user in the given workspace.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace to query for webhooks in.

Asana.getSingleWebhook

Returns the full record for the given webhook.

FieldTypeDescription
accessTokencredentialsYour access token.
webhookStringThe webhook to get.

Asana.deleteWebhook

This method permanently removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued.

FieldTypeDescription
accessTokencredentialsYour access token.
webhookStringThe webhook to delete.

Asana.getWorkplaces

Returns the full workspace record for a single workspace.

FieldTypeDescription
accessTokencredentialsYour access token.

Asana.updateWorkplace

Currently the only field that can be modified for a workspace is its name.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace to update.
nameStringThe workspace name.

Asana.typeaheadSearch

Retrieves objects in the workspace based on an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won’t be able to fetch large numbers of results.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace to fetch objects from.
typeStringThe type of values the typeahead should return. 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.
queryStringThe string that will be used to search for relevant objects. If an empty string is passed in, the API will currently return an empty result set.
countNumberThe 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.

Asana.addUserToWorkspace

The user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace or organization to invite the user to.
userStringAn identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword me to indicate the current user making the request.

Asana.removeUserFromWorkspace

The user making this call must be an admin in the workspace. Returns an empty data record.

FieldTypeDescription
accessTokencredentialsYour access token.
workspaceStringThe workspace or organization to invite the user to.
userStringAn identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword me to indicate the current user making the request.
x
circle
Asana
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view