API - Corsair

Every asana.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Projects

addFollowers

projects.addFollowers Add followers to a project Risk: write

await corsair.asana.api.projects.addFollowers({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`followers`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

addMembers

projects.addMembers Add members to a project Risk: write

await corsair.asana.api.projects.addMembers({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`members`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

create

projects.create Create a project Risk: write

await corsair.asana.api.projects.create({});

Input

Name	Type	Required	Description
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  team?: string,
  workspace?: string,
  notes?: string,
  html_notes?: string,
  color?: string,
  due_on?: string,
  start_on?: string,
  archived?: boolean,
  followers?: string[],
  owner?: string,
  public?: boolean,
  default_view?: string,
  privacy_setting?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}

createForTeam

projects.createForTeam Create a project for a team Risk: write

await corsair.asana.api.projects.createForTeam({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  notes?: string,
  color?: string,
  due_on?: string,
  start_on?: string,
  archived?: boolean,
  followers?: string[],
  owner?: string,
  public?: boolean,
  default_view?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}

createForWorkspace

projects.createForWorkspace Create a project for a workspace Risk: write

await corsair.asana.api.projects.createForWorkspace({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  team?: string,
  notes?: string,
  color?: string,
  due_on?: string,
  start_on?: string,
  archived?: boolean,
  followers?: string[],
  owner?: string,
  public?: boolean,
  default_view?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}

delete

projects.delete Delete a project [DESTRUCTIVE] Risk: destructive

await corsair.asana.api.projects.delete({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

duplicate

projects.duplicate Duplicate a project Risk: write

await corsair.asana.api.projects.duplicate({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name: string,
  team?: string,
  include?: string,
  schedule_dates?: {
    should_skip_weekends: boolean,
    due_on?: string,
    start_on?: string
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  status?: string,
  new_project?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  new_task?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

get

projects.get Get a project by GID Risk: read

await corsair.asana.api.projects.get({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}

getTaskCounts

projects.getTaskCounts Get task counts for a project Risk: read

await corsair.asana.api.projects.getTaskCounts({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  num_tasks?: number,
  num_completed_tasks?: number,
  num_incomplete_tasks?: number,
  num_milestones?: number,
  num_completed_milestones?: number,
  num_incomplete_milestones?: number
}

getTasks

projects.getTasks Get tasks in a project Risk: read

await corsair.asana.api.projects.getTasks({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`completed_since`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

list

projects.list List projects Risk: read

await corsair.asana.api.projects.list({});

Input

Name	Type	Required	Description
`workspace`	`string`	No	—
`team`	`string`	No	—
`archived`	`boolean`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

listForWorkspace

projects.listForWorkspace List projects in a workspace Risk: read

await corsair.asana.api.projects.listForWorkspace({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`archived`	`boolean`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

removeFollowers

projects.removeFollowers Remove followers from a project Risk: write

await corsair.asana.api.projects.removeFollowers({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`followers`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string
}

removeMembers

projects.removeMembers Remove members from a project Risk: write

await corsair.asana.api.projects.removeMembers({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`members`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string
}

update

projects.update Update a project Risk: write

await corsair.asana.api.projects.update({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string,
  due_on?: string,
  start_on?: string,
  archived?: boolean,
  owner?: string,
  public?: boolean,
  default_view?: string,
  privacy_setting?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  color?: string | null,
  archived?: boolean,
  completed?: boolean,
  due_on?: string | null,
  start_on?: string | null,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  members?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  public?: boolean,
  resource_type?: string,
  created_at?: string,
  modified_at?: string,
  permalink_url?: string,
  default_view?: string,
  privacy_setting?: string,
  icon?: string | null,
  custom_fields?: {
  }[]
}

Sections

create

sections.create Create a section in a project Risk: write

await corsair.asana.api.sections.create({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name: string,
  insert_before?: string,
  insert_after?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  created_at?: string,
  project?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

delete

sections.delete Delete a section [DESTRUCTIVE] Risk: destructive

await corsair.asana.api.sections.delete({});

Input

Name	Type	Required	Description
`section_gid`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

get

sections.get Get a section by GID Risk: read

await corsair.asana.api.sections.get({});

Input

Name	Type	Required	Description
`section_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  created_at?: string,
  project?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

insert

sections.insert Insert a section at a specific position Risk: write

await corsair.asana.api.sections.insert({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_pretty`	`boolean`	No	—

data full type

{
  section: string,
  before_section?: string,
  after_section?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

list

sections.list List sections in a project Risk: read

await corsair.asana.api.sections.list({});

Input

Name	Type	Required	Description
`project_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  created_at?: string,
  project?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

update

sections.update Update a section Risk: write

await corsair.asana.api.sections.update({});

Input

Name	Type	Required	Description
`section_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  created_at?: string,
  project?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

Stories

createComment

stories.createComment Create a comment on a task Risk: write

await corsair.asana.api.stories.createComment({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  text?: string,
  html_text?: string,
  is_pinned?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  text?: string,
  html_text?: string,
  type?: string,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  created_by?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  liked?: boolean,
  num_likes?: number,
  is_edited?: boolean,
  is_pinned?: boolean,
  target?: {
    gid: string,
    name?: string
  } | null
}

delete

stories.delete Delete a story [DESTRUCTIVE] Risk: destructive

await corsair.asana.api.stories.delete({});

Input

Name	Type	Required	Description
`story_gid`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

get

stories.get Get a story by GID Risk: read

await corsair.asana.api.stories.get({});

Input

Name	Type	Required	Description
`story_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  text?: string,
  html_text?: string,
  type?: string,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  created_by?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  liked?: boolean,
  num_likes?: number,
  is_edited?: boolean,
  is_pinned?: boolean,
  target?: {
    gid: string,
    name?: string
  } | null
}

listForTask

stories.listForTask List stories for a task Risk: read

await corsair.asana.api.stories.listForTask({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  text?: string,
  html_text?: string,
  type?: string,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  created_by?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  liked?: boolean,
  num_likes?: number,
  is_edited?: boolean,
  is_pinned?: boolean,
  target?: {
    gid: string,
    name?: string
  } | null
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

update

stories.update Update a story Risk: write

await corsair.asana.api.stories.update({});

Input

Name	Type	Required	Description
`story_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  text?: string,
  html_text?: string,
  is_pinned?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  text?: string,
  html_text?: string,
  type?: string,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  created_by?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  liked?: boolean,
  num_likes?: number,
  is_edited?: boolean,
  is_pinned?: boolean,
  target?: {
    gid: string,
    name?: string
  } | null
}

Tasks

addDependencies

tasks.addDependencies Add task dependencies Risk: write

await corsair.asana.api.tasks.addDependencies({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`dependencies`	`string[]`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string
}[]

addFollowers

tasks.addFollowers Add followers to a task Risk: write

await corsair.asana.api.tasks.addFollowers({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`followers`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string
}

addProject

tasks.addProject Add a task to a project Risk: write

await corsair.asana.api.tasks.addProject({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`project`	`string`	Yes	—
`section`	`string`	No	—
`insert_after`	`string`	No	—
`insert_before`	`string`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

addTag

tasks.addTag Add a tag to a task Risk: write

await corsair.asana.api.tasks.addTag({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`tag`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

addToSection

tasks.addToSection Add a task to a section Risk: write

await corsair.asana.api.tasks.addToSection({});

Input

Name	Type	Required	Description
`section_gid`	`string`	Yes	—
`task`	`string`	Yes	—
`insert_before`	`string`	No	—
`insert_after`	`string`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

create

tasks.create Create a new task Risk: write

await corsair.asana.api.tasks.create({});

Input

Name	Type	Required	Description
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  notes?: string,
  html_notes?: string,
  due_on?: string,
  due_at?: string,
  start_on?: string,
  start_at?: string,
  assignee?: string,
  projects?: string[],
  tags?: string[],
  followers?: string[],
  workspace?: string,
  parent?: string,
  completed?: boolean,
  liked?: boolean,
  resource_subtype?: string,
  custom_fields?: {
  },
  assignee_section?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}

createSubtask

tasks.createSubtask Create a subtask Risk: write

await corsair.asana.api.tasks.createSubtask({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  notes?: string,
  assignee?: string,
  due_on?: string,
  due_at?: string,
  completed?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}

delete

tasks.delete Delete a task [DESTRUCTIVE] Risk: destructive

await corsair.asana.api.tasks.delete({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

duplicate

tasks.duplicate Duplicate a task Risk: write

await corsair.asana.api.tasks.duplicate({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`data`	`object`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  include?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  status?: string,
  new_project?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  new_task?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

get

tasks.get Get a task by GID Risk: read

await corsair.asana.api.tasks.get({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}

getAttachments

tasks.getAttachments Get attachments for a task Risk: read

await corsair.asana.api.tasks.getAttachments({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

getStories

tasks.getStories Get stories (activity) for a task Risk: read

await corsair.asana.api.tasks.getStories({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  text?: string,
  html_text?: string,
  type?: string,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  created_by?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  liked?: boolean,
  num_likes?: number,
  is_edited?: boolean,
  is_pinned?: boolean,
  target?: {
    gid: string,
    name?: string
  } | null
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

getSubtasks

tasks.getSubtasks Get subtasks of a task Risk: read

await corsair.asana.api.tasks.getSubtasks({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

getTags

tasks.getTags Get tags on a task Risk: read

await corsair.asana.api.tasks.getTags({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  color?: string | null,
  notes?: string,
  resource_type?: string,
  created_at?: string,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  permalink_url?: string
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

list

tasks.list List tasks Risk: read

await corsair.asana.api.tasks.list({});

Input

Name	Type	Required	Description
`assignee`	`string`	No	—
`project`	`string`	No	—
`section`	`string`	No	—
`workspace`	`string`	No	—
`tag`	`string`	No	—
`user_task_list`	`string`	No	—
`completed_since`	`string`	No	—
`modified_since`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

removeFollower

tasks.removeFollower Remove a follower from a task Risk: write

await corsair.asana.api.tasks.removeFollower({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`followers`	`string[]`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string
}

removeProject

tasks.removeProject Remove a task from a project Risk: write

await corsair.asana.api.tasks.removeProject({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`project`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

removeTag

tasks.removeTag Remove a tag from a task Risk: write

await corsair.asana.api.tasks.removeTag({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`tag`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

search

tasks.search Search tasks in a workspace Risk: read

await corsair.asana.api.tasks.search({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`text`	`string`	No	—
`resource_subtype`	`string`	No	—
`assignee`	`string`	No	—
`project`	`string`	No	—
`section`	`string`	No	—
`tag`	`string`	No	—
`team`	`string`	No	—
`completed`	`boolean`	No	—
`is_subtask`	`boolean`	No	—
`has_attachment`	`boolean`	No	—
`is_blocked`	`boolean`	No	—
`is_blocking`	`boolean`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

setParent

tasks.setParent Set the parent of a task Risk: write

await corsair.asana.api.tasks.setParent({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`parent`	`string`	No	—
`insert_after`	`string`	No	—
`insert_before`	`string`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}

update

tasks.update Update a task Risk: write

await corsair.asana.api.tasks.update({});

Input

Name	Type	Required	Description
`task_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  notes?: string,
  html_notes?: string,
  due_on?: string,
  due_at?: string,
  start_on?: string,
  start_at?: string,
  assignee?: string,
  completed?: boolean,
  liked?: boolean,
  resource_subtype?: string,
  approval_status?: string,
  assignee_status?: string,
  assignee_section?: string,
  workspace?: string,
  custom_fields?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  notes?: string,
  html_notes?: string,
  completed?: boolean,
  due_on?: string | null,
  due_at?: string | null,
  start_on?: string | null,
  start_at?: string | null,
  assignee?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  assignee_status?: string,
  assignee_section?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  projects?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  tags?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  followers?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[],
  parent?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null,
  resource_type?: string,
  resource_subtype?: string,
  created_at?: string,
  modified_at?: string,
  completed_at?: string | null,
  liked?: boolean,
  num_likes?: number,
  permalink_url?: string,
  num_subtasks?: number,
  approval_status?: string,
  custom_fields?: {
  }[]
}

Teams

addUser

teams.addUser Add a user to a team Risk: write

await corsair.asana.api.teams.addUser({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`user`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_admin?: boolean,
  is_guest?: boolean,
  is_limited_access?: boolean,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

create

teams.create Create a team Risk: write

await corsair.asana.api.teams.create({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name: string,
  description?: string,
  html_description?: string,
  visibility?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string,
  permalink_url?: string,
  resource_type?: string,
  organization?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null
}

get

teams.get Get a team by GID Risk: read

await corsair.asana.api.teams.get({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string,
  permalink_url?: string,
  resource_type?: string,
  organization?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null
}

listForUser

teams.listForUser List teams for a user Risk: read

await corsair.asana.api.teams.listForUser({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`organization`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string,
  permalink_url?: string,
  resource_type?: string,
  organization?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

listForWorkspace

teams.listForWorkspace List teams in a workspace Risk: read

await corsair.asana.api.teams.listForWorkspace({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string,
  permalink_url?: string,
  resource_type?: string,
  organization?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

membershipsGet

teams.membershipsGet Get a team membership Risk: read

await corsair.asana.api.teams.membershipsGet({});

Input

Name	Type	Required	Description
`team_membership_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_admin?: boolean,
  is_guest?: boolean,
  is_limited_access?: boolean,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

membershipsList

teams.membershipsList List team memberships Risk: read

await corsair.asana.api.teams.membershipsList({});

Input

Name	Type	Required	Description
`team`	`string`	No	—
`user`	`string`	No	—
`workspace`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_admin?: boolean,
  is_guest?: boolean,
  is_limited_access?: boolean,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

membershipsListForTeam

teams.membershipsListForTeam List memberships for a team Risk: read

await corsair.asana.api.teams.membershipsListForTeam({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_admin?: boolean,
  is_guest?: boolean,
  is_limited_access?: boolean,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

membershipsListForUser

teams.membershipsListForUser List team memberships for a user Risk: read

await corsair.asana.api.teams.membershipsListForUser({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`workspace`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_admin?: boolean,
  is_guest?: boolean,
  is_limited_access?: boolean,
  team?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

removeUser

teams.removeUser Remove a user from a team Risk: write

await corsair.asana.api.teams.removeUser({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`user`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
}

update

teams.update Update a team Risk: write

await corsair.asana.api.teams.update({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  description?: string,
  html_description?: string,
  visibility?: string,
  permalink_url?: string,
  resource_type?: string,
  organization?: {
    gid: string,
    name?: string,
    resource_type?: string
  } | null
}

Users

get

users.get Get a user by GID Risk: read

await corsair.asana.api.users.get({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  email?: string,
  resource_type?: string,
  photo?: {
  } | null,
  workspaces?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

getCurrent

users.getCurrent Get the currently authenticated user Risk: read

await corsair.asana.api.users.getCurrent({});

Input

Name	Type	Required	Description
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  email?: string,
  resource_type?: string,
  photo?: {
  } | null,
  workspaces?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}

getFavorites

users.getFavorites Get a user’s favorites Risk: read

await corsair.asana.api.users.getFavorites({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`resource_type`	`string`	Yes	—
`workspace`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string
}[]

getTaskList

users.getTaskList Get a user’s task list Risk: read

await corsair.asana.api.users.getTaskList({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`workspace`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

getUserTaskList

users.getUserTaskList Get a user task list by GID Risk: read

await corsair.asana.api.users.getUserTaskList({});

Input

Name	Type	Required	Description
`user_task_list_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  owner?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  }
}

list

users.list List users Risk: read

await corsair.asana.api.users.list({});

Input

Name	Type	Required	Description
`workspace`	`string`	No	—
`team`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  email?: string,
  resource_type?: string,
  photo?: {
  } | null,
  workspaces?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

listForTeam

users.listForTeam List users in a team Risk: read

await corsair.asana.api.users.listForTeam({});

Input

Name	Type	Required	Description
`team_gid`	`string`	Yes	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  email?: string,
  resource_type?: string,
  photo?: {
  } | null,
  workspaces?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

listForWorkspace

users.listForWorkspace List users in a workspace Risk: read

await corsair.asana.api.users.listForWorkspace({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  email?: string,
  resource_type?: string,
  photo?: {
  } | null,
  workspaces?: {
    gid: string,
    name?: string,
    resource_type?: string
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

Webhook Management

create

webhookManagement.create Register a new webhook Risk: write

await corsair.asana.api.webhookManagement.create({});

Input

Name	Type	Required	Description
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  resource: string,
  target: string,
  filters?: {
    resource_type?: string,
    resource_subtype?: string,
    action?: string,
    fields?: string[]
  }[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  active?: boolean,
  created_at?: string,
  target?: string,
  resource?: {
    gid: string,
    name?: string
  },
  filters?: {
    resource_type?: string,
    resource_subtype?: string,
    action?: string,
    fields?: string[]
  }[]
}

delete

webhookManagement.delete Delete a webhook [DESTRUCTIVE] Risk: destructive

await corsair.asana.api.webhookManagement.delete({});

Input

Name	Type	Required	Description
`webhook_gid`	`string`	Yes	—
`opt_pretty`	`boolean`	No	—

Output: empty object

getList

webhookManagement.getList List webhooks Risk: read

await corsair.asana.api.webhookManagement.getList({});

Input

Name	Type	Required	Description
`workspace`	`string`	Yes	—
`resource`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  active?: boolean,
  created_at?: string,
  target?: string,
  resource?: {
    gid: string,
    name?: string
  },
  filters?: {
    resource_type?: string,
    resource_subtype?: string,
    action?: string,
    fields?: string[]
  }[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

update

webhookManagement.update Update a webhook Risk: write

await corsair.asana.api.webhookManagement.update({});

Input

Name	Type	Required	Description
`webhook_gid`	`string`	Yes	—
`data`	`object`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

data full type

{
  filters?: {
    resource_type?: string,
    resource_subtype?: string,
    action?: string,
    fields?: string[]
  }[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  active?: boolean,
  created_at?: string,
  target?: string,
  resource?: {
    gid: string,
    name?: string
  },
  filters?: {
    resource_type?: string,
    resource_subtype?: string,
    action?: string,
    fields?: string[]
  }[]
}

Workspaces

get

workspaces.get Get a workspace by GID Risk: read

await corsair.asana.api.workspaces.get({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  is_organization?: boolean,
  email_domains?: string[]
}

list

workspaces.list List workspaces Risk: read

await corsair.asana.api.workspaces.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  name?: string,
  resource_type?: string,
  is_organization?: boolean,
  email_domains?: string[]
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

membershipsGet

workspaces.membershipsGet Get a workspace membership Risk: read

await corsair.asana.api.workspaces.membershipsGet({});

Input

Name	Type	Required	Description
`workspace_membership_gid`	`string`	Yes	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_active?: boolean,
  is_admin?: boolean,
  is_guest?: boolean,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user_task_list?: {
    gid: string,
    name?: string
  }
}

membershipsList

workspaces.membershipsList List workspace memberships Risk: read

await corsair.asana.api.workspaces.membershipsList({});

Input

Name	Type	Required	Description
`workspace_gid`	`string`	Yes	—
`user`	`string`	No	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_active?: boolean,
  is_admin?: boolean,
  is_guest?: boolean,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user_task_list?: {
    gid: string,
    name?: string
  }
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

membershipsListForUser

workspaces.membershipsListForUser List workspace memberships for a user Risk: read

await corsair.asana.api.workspaces.membershipsListForUser({});

Input

Name	Type	Required	Description
`user_gid`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`string`	No	—
`opt_fields`	`string[]`	No	—
`opt_pretty`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`next_page`	`object`	No	—

data full type

{
  gid: string,
  resource_type?: string,
  is_active?: boolean,
  is_admin?: boolean,
  is_guest?: boolean,
  workspace?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user?: {
    gid: string,
    name?: string,
    resource_type?: string
  },
  user_task_list?: {
    gid: string,
    name?: string
  }
}[]

next_page full type

{
  offset?: string,
  path?: string,
  uri?: string
}

Overview

Plugins

​Projects

​addFollowers

​addMembers

​create

​createForTeam

​createForWorkspace

​delete

​duplicate

​get

​getTaskCounts

​getTasks

​list

​listForWorkspace

​removeFollowers

​removeMembers

​update

​Sections

​create

​delete

​get

​insert

​list

​update

​Stories

​createComment

​delete

​get

​listForTask

​update

​Tags

​create

​createInWorkspace

​delete

​get

​getTasks

​list

​listForTask

​listForWorkspace

​update

​Tasks

​addDependencies

​addFollowers

​addProject

​addTag

​addToSection

​create

​createSubtask

​delete

​duplicate

​get

​getAttachments

​getStories

​getSubtasks

​getTags

​list

​removeFollower

​removeProject

​removeTag

​search

​setParent

​update

​Teams

​addUser

​create

​get

​listForUser

​listForWorkspace

​membershipsGet

​membershipsList

​membershipsListForTeam

​membershipsListForUser

​removeUser

​update

​Users

​get

​getCurrent

​getFavorites

​getTaskList

Projects

addFollowers

addMembers

create

createForTeam

createForWorkspace

delete

duplicate

get

getTaskCounts

getTasks

list

listForWorkspace

removeFollowers

removeMembers

update

Sections

create

delete

get

insert

list

update

Stories

createComment

delete

get

listForTask

update

Tags

create

createInWorkspace

delete

get

getTasks

list

listForTask

listForWorkspace

update

Tasks

addDependencies

addFollowers

addProject

addTag

addToSection

create

createSubtask

delete

duplicate

get

getAttachments

getStories

getSubtasks

getTags

list

removeFollower

removeProject

removeTag

search

setParent

update

Teams

addUser

create

get

listForUser

listForWorkspace

membershipsGet

membershipsList

membershipsListForTeam

membershipsListForUser

removeUser

update

Users

get

getCurrent

getFavorites

getTaskList

getUserTaskList

list