@datafire/asana v3.0.0

@datafire/asana

Client library for ASANA Developers API

Installation and Usage

npm install --save @datafire/asana

let asana = require('@datafire/asana').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

ASANA Developers API

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

asana.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

asana.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

workspaces.workspace_gid.tags.post

Creates a new tag in a workspace or organization.

asana.workspaces.workspace_gid.tags.post({}, context)

Input

• input object
  • workspace_gid string: The workspace or organization to create the tag in.
  • name string: Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • color string: Color of the tag. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • workspace string: The workspace or organization this tag is associated with. Once created, tags cannot be moved to a different workspace. This attribute can only be specified at creation time.

Output

Output schema unknown

workspaces.workspace_gid.tags.get

Returns the compact tag records for all tags in the workspace.

asana.workspaces.workspace_gid.tags.get({}, context)

Input

• input object
  • workspace_gid string: The workspace or organization to find tags in.
  • name string: Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • color string: Color of the tag. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • workspace string: The workspace or organization this tag is associated with. Once created, tags cannot be moved to a different workspace. This attribute can only be specified at creation time.

Output

• output object
  • data required array

projects.project_gid.project_memberships.get

Returns the compact project membership records for the project.

asana.projects.project_gid.project_memberships.get({}, context)

Input

• input object
  • project_gid string: The project for which to fetch memberships.
  • user string: If present, the user to filter the memberships to.

Output

• output object
  • data required array

tasks.task_gid.dependents.get

Returns the compact representations of all of the dependents of a task.

asana.tasks.task_gid.dependents.get({}, context)

Input

• input object
  • task_gid string: The task to get dependents on.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

tasks.task_gid.put

A specific, existing task can be updated by making a PUT request on the URL for that task. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.

asana.tasks.task_gid.put({}, context)

Input

• input object
  • task_gid string: The task to update.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

• output object
  • data required object
    • assignee required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • gid required string
    • id required integer
    • resource_type required string
    • ... required string

tasks.task_gid.delete

A specific, existing task can be deleted by making a DELETE request on the URL for that task. 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.

asana.tasks.task_gid.delete({}, context)

Input

• input object
  • task_gid string: The task to delete.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

• output object
  • data required object

tasks.task_gid.get

Returns the complete task record for a single task.

asana.tasks.task_gid.get({}, context)

Input

• input object
  • task_gid string: The task to get.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

• output object
  • data required object
    • assignee required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • created_at required string
    • ... required string

events.get

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

asana.events.get({}, context)

Input

• input object
  • resource string: A resource ID to subscribe to. The resource can be a task or project.
  • sync string: 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. 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 error, and include a fresh token in the response.

Output

• output object
  • data required array
    • items object
      • resource required object
        • resource_subtype required string
        • gid required string
        • id required integer
        • resource_type required string
        • name required string
      • parent required null
      • created_at required string
      • user required object
        • gid required string
        • id required integer
        • resource_type required string
        • name required string
      • action required string
      • type required string
  • sync required string

workspaces.workspace_gid.removeUser.post

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

asana.workspaces.workspace_gid.removeUser.post({}, context)

Input

• input object
  • workspace_gid string: The workspace or organization to invite the user to.
  • user string: An identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword to indicate the current user making the request.
  • name string: The name of the workspace.
  • is_organization string: Whether the workspace is an .

Output

Output schema unknown

tasks.task_gid.removeProject.post

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

asana.tasks.task_gid.removeProject.post({}, context)

Input

• input object
  • task_gid string: The task to remove from a project.
  • project string: The project to remove the task from.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

workspaces.workspace_gid.tasks.search.get

The search endpoint allows you to build complex queries to find and fetch exactly the data you need from Asana. For a more comprehensive description of all the query parameters and limitations of this endpoint, see our long-form documentation for this feature.

asana.workspaces.workspace_gid.tasks.search.get({}, context)

Input

• input object
  • workspace_gid string: The workspace or organization in which to search for tasks.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

• output object
  • data required array

tasks.task_gid.projects.get

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

asana.tasks.task_gid.projects.get({}, context)

Input

• input object
  • task_gid string: The task to get projects on.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

tasks.task_gid.removeTag.post

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

asana.tasks.task_gid.removeTag.post({}, context)

Input

• input object
  • task_gid string: The task to remove a tag from.
  • tag string: The tag to remove from the task.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

sections.section_gid.put

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.)

asana.sections.section_gid.put({}, context)

Input

• input object
  • section_gid string: The section to update.
  • name string: The name of the section (i.e. the text displayed as the section header).

Output

• output object
  • data required array
    • items object
      • name required string
      • created_at required string
      • project required object
        • gid required string
        • id required integer
        • resource_type required string
        • name required string
      • gid required string
      • id required integer
      • resource_type required string

sections.section_gid.delete

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

asana.sections.section_gid.delete({}, context)

Input

• input object
  • section_gid string: The section to delete.
  • name string: The name of the section (i.e. the text displayed as the section header).

Output

• output object
  • data required object

sections.section_gid.get

Returns the complete record for a single section.

asana.sections.section_gid.get({}, context)

Input

• input object
  • section_gid string: The section to get.
  • name string: The name of the section (i.e. the text displayed as the section header).

Output

Output schema unknown

workspaces.workspace_gid.users.get

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

asana.workspaces.workspace_gid.users.get({}, context)

Input

• input object
  • workspace_gid string: The workspace in which to get users.

Output

• output object
  • data required array
    • items object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string

project_statuses.project_status_gid.delete

Deletes a specific, existing project status update.

asana.project_statuses.project_status_gid.delete({}, context)

Input

• input object
  • project-status_gid string: The project status update to delete.

Output

• output object
  • data required object

project_statuses.project_status_gid.get

Returns the complete record for a single status update.

asana.project_statuses.project_status_gid.get({}, context)

Input

• input object
  • project-status_gid string: The project status update to get.

Output

• output object
  • data required object
    • title required string
    • color required string
    • text required string
    • created_at required string
    • created_by required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • gid required string
    • id required integer
    • resource_type required string

teams.team_gid.projects.post

Creates a project shared with the given team.

asana.teams.team_gid.projects.post({}, context)

Input

• input object
  • team_gid string: The team to create the project in.
  • name string: Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • owner string: The current owner of the project, may be null.
  • due_date string: The day on which this project is due. This takes a date with format YYYY-MM-DD.
  • start_on string: The day on which this project starts. This takes a date with format YYYY-MM-DD.
  • archived string: True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
  • public string: True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
  • color string: Color of the project. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • notes string: More detailed, free-form textual information associated with the project.
  • html_notes string: The notes of the project with formatting as HTML.
  • workspace string: The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • team string: The team that this project is shared with. This field only exists for projects in organizations.
  • layout string: The layout (board or list view) of the project.

Output

Output schema unknown

teams.team_gid.projects.get

Returns the compact project records for all projects in the team.

asana.teams.team_gid.projects.get({}, context)

Input

• input object
  • team_gid string: The team to find projects in.
  • archived string: Only return projects whose field takes on the value of this parameter.
  • name string: Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • owner string: The current owner of the project, may be null.
  • due_date string: The day on which this project is due. This takes a date with format YYYY-MM-DD.
  • start_on string: The day on which this project starts. This takes a date with format YYYY-MM-DD.
  • public string: True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
  • color string: Color of the project. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • notes string: More detailed, free-form textual information associated with the project.
  • html_notes string: The notes of the project with formatting as HTML.
  • workspace string: The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • team string: The team that this project is shared with. This field only exists for projects in organizations.
  • layout string: The layout (board or list view) of the project.

Output

Output schema unknown

users.user_gid.teams.get

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

asana.users.user_gid.teams.get({}, context)

Input

• input object
  • user_gid string: An identifier for the user. Can be one of an email address, the globally unique identifier for the user, or the keyword to indicate the current user making the request.
  • organization string: The workspace or organization to filter teams on.
  • name string: The name of the team.
  • description string: The description of the team.
  • html_description string: The description of the team with formatting as HTML.

Output

Output schema unknown

workspaces.workspace_gid.custom_fields.get

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

asana.workspaces.workspace_gid.custom_fields.get({}, context)

Input

• input object
  • workspace_gid string: The workspace or organization to find custom field definitions in.
  • resource_subtype string: The type of custom field. Must be one of the given values.
  • name string: The name of the custom field.
  • description string: The description of the custom field.
  • type string: The type of the custom field. Must be one of the given values.
  • precision string: Only relevant for custom fields of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.

Output

• output object
  • data required array

teams.team_gid.users.get

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

asana.teams.team_gid.users.get({}, context)

Input

• input object
  • team_gid string: Globally unique identifier for the team.
  • name string: The name of the team.
  • description string: The description of the team.
  • html_description string: The description of the team with formatting as HTML.

Output

Output schema unknown

projects.project_gid.put

A specific, existing project 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.

asana.projects.project_gid.put({}, context)

Input

• input object
  • project_gid string: The project to update.
  • name string: Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • owner string: The current owner of the project, may be null.
  • due_date string: The day on which this project is due. This takes a date with format YYYY-MM-DD.
  • start_on string: The day on which this project starts. This takes a date with format YYYY-MM-DD.
  • archived string: True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
  • public string: True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
  • color string: Color of the project. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • notes string: More detailed, free-form textual information associated with the project.
  • html_notes string: The notes of the project with formatting as HTML.
  • workspace string: The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • team string: The team that this project is shared with. This field only exists for projects in organizations.
  • layout string: The layout (board or list view) of the project.

Output

• output object
  • data required object
    • name required string
    • notes required string
    • gid required string
    • null required string
    • id required integer
    • resource_type required string

projects.project_gid.delete

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

asana.projects.project_gid.delete({}, context)

Input

• input object
  • project_gid string: The project to delete.
  • name string: Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • owner string: The current owner of the project, may be null.
  • due_date string: The day on which this project is due. This takes a date with format YYYY-MM-DD.
  • start_on string: The day on which this project starts. This takes a date with format YYYY-MM-DD.
  • archived string: True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
  • public string: True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
  • color string: Color of the project. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • notes string: More detailed, free-form textual information associated with the project.
  • html_notes string: The notes of the project with formatting as HTML.
  • workspace string: The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • team string: The team that this project is shared with. This field only exists for projects in organizations.
  • layout string: The layout (board or list view) of the project.

Output

• output object
  • data required object

projects.project_gid.get

Returns the complete project record for a single project.

asana.projects.project_gid.get({}, context)

Input

• input object
  • project_gid string: The project to get.
  • name string: Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • owner string: The current owner of the project, may be null.
  • due_date string: The day on which this project is due. This takes a date with format YYYY-MM-DD.
  • start_on string: The day on which this project starts. This takes a date with format YYYY-MM-DD.
  • archived string: True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
  • public string: True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
  • color string: Color of the project. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • notes string: More detailed, free-form textual information associated with the project.
  • html_notes string: The notes of the project with formatting as HTML.
  • workspace string: The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • team string: The team that this project is shared with. This field only exists for projects in organizations.
  • layout string: The layout (board or list view) of the project.

Output

• output object
  • data required object
    • name required string
    • notes required string
    • gid required string
    • null required string
    • id required integer
    • resource_type required string

projects.project_gid.custom_field_settings.get

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.

asana.projects.project_gid.custom_field_settings.get({}, context)

Input

• input object
  • project_gid string: The ID of the project for which to list custom field settings

Output

• output object
  • data required array

teams.team_gid.get

Returns the full record for a single team.

asana.teams.team_gid.get({}, context)

Input

• input object
  • team_gid string: Globally unique identifier for the team.
  • name string: The name of the team.
  • description string: The description of the team.
  • html_description string: The description of the team with formatting as HTML.

Output

Output schema unknown

workspaces.workspace_gid.tasks.post

Creating a new task is as easy as POSTing to the /tasks endpoint with a data block containing the fields you’d like to set on the task. Any unspecified fields will take on default values.

asana.workspaces.workspace_gid.tasks.post({}, context)

Input

• input object
  • workspace_gid string: The workspace to create a task in.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

tags.tag_gid.put

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

asana.tags.tag_gid.put({}, context)

Input

• input object
  • tag_gid string: The tag to update.
  • name string: Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • color string: Color of the tag. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • workspace string: The workspace or organization this tag is associated with. Once created, tags cannot be moved to a different workspace. This attribute can only be specified at creation time.

Output

• output object
  • data required object
    • gid required string
    • null required string
    • id required integer
    • resource_type required string
    • name required string

tags.tag_gid.get

Returns the complete tag record for a single tag.

asana.tags.tag_gid.get({}, context)

Input

• input object
  • tag_gid string: The tag to get.
  • name string: Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
  • color string: Color of the tag. Must be either or one of: , , , , , , , , , , , , , , , , , .
  • workspace string: The workspace or organization this tag is associated with. Once created, tags cannot be moved to a different workspace. This attribute can only be specified at creation time.

Output

• output object
  • data required object
    • gid required string
    • null required string
    • id required integer
    • resource_type required string
    • name required string

organizations.organization_gid.teams.get

Returns the compact records for all teams in the organization visible to the authorized user.

asana.organizations.organization_gid.teams.get({}, context)

Input

• input object
  • organization_gid string: Globally unique identifier for the workspace or organization.
  • name string: The name of the team.
  • description string: The description of the team.
  • html_description string: The description of the team with formatting as HTML.

Output

Output schema unknown

tasks.task_gid.subtasks.post

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

asana.tasks.task_gid.subtasks.post({}, context)

Input

• input object
  • task_gid string: The task to add a subtask to.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

• output object
  • data required object
    • name required string
    • parent required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • assignee required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • notes required string
    • modified_at required string
    • id required integer
    • assignee_status required string
    • completed_at required null
    • completed required boolean
    • followers required array
      • items object
        • gid required string
        • id required integer
        • resource_type required string
        • name required string
    • projects required array
    • workspace required object
      • gid required string
      • id required integer
      • resource_type required string
      • name required string
    • due_on required null
    • gid required string
    • created_at required string
    • resource_type required string

tasks.task_gid.subtasks.get

Returns a compact representation of all of the subtasks of a task.

asana.tasks.task_gid.subtasks.get({}, context)

Input

• input object
  • task_gid string: The task to get the subtasks of.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied to the task. These custom fields represent the values recorded on this task for a particular custom field. For example, these fields will contain an property for custom fields of type , a property for custom fields of type , and so on. Please note that the id returned on each custom field value to the id of the custom field, which allows referencing the custom field metadata through the endpoint.
  • due_on string: Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with .
  • due_at string: Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with .
  • external string: The external field allows you to store app-specific metadata on tasks, including an id that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external id is set, you can use the notation to reference your object anywhere in the API where you may use the original object id. See the page on Custom External Data for more details.
  • followers string: Array of users following this task.
  • liked string: True if the task is liked by the authorized user, false if not.
  • name string: Name 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.
  • notes string: More detailed, free-form textual information associated with the task.
  • html_notes string: The notes of the text with formatting as HTML.
  • projects string: Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the and endpoints.
  • start_on string: Date on which this task is due, or null if the task has no start date. This field takes a date with YYYY-MM-DD format. or must be present in the request when setting or unsetting the parameter.
  • workspace string: The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.
  • memberships string: Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the and endpoints. Note that over time, more types of memberships may be added to this property.
  • tags string: Array of tags associated with this task. This property may be specified on creation using just an array of tag IDs. In order to change tags on an existing task use and .

Output

Output schema unknown

tasks.task_gid.addFollowers.post

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

asana.tasks.task_gid.addFollowers.post({}, context)

Input

• input object
  • task_gid string: The task to add followers to.
  • followers string: An array of followers to add to the task.
  • assignee string: User to which this task is assigned, or if the task is unassigned.
  • assignee_status string: Scheduling status of this task for the user it is assigned to. This field can only be set if the is non-null.
  • completed string: True if the task is currently marked complete, false if not.
  • custom_fields string: Array of custom fields applied