> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# API
> API reference for Asana: every `asana.api.*` operation with input and output types.
Every `asana.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.
**New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
## Projects
### addFollowers
`projects.addFollowers`
Add followers to a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
followers?: {
gid: string,
name?: string,
resource_type?: string
}[]
}
```
***
### addMembers
`projects.addMembers`
Add members to a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
members?: {
gid: string,
name?: string,
resource_type?: string
}[]
}
```
***
### create
`projects.create`
Create a project
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.projects.create({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### duplicate
`projects.duplicate`
Duplicate a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### list
`projects.list`
List projects
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForWorkspace
`projects.listForWorkspace`
List projects in a workspace
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### removeFollowers
`projects.removeFollowers`
Remove followers from a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string
}
```
***
### removeMembers
`projects.removeMembers`
Remove members from a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string
}
```
***
### update
`projects.update`
Update a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
name: string,
insert_before?: string,
insert_after?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### get
`sections.get`
Get a section by GID
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
await corsair.asana.api.sections.insert({});
```
**Input**
| Name | Type | Required | Description |
| ------------- | --------- | -------- | ----------- |
| `project_gid` | `string` | Yes | — |
| `data` | `object` | Yes | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
section: string,
before_section?: string,
after_section?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
}
```
***
### list
`sections.list`
List sections in a project
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### update
`sections.update`
Update a section
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
name?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
text?: string,
html_text?: string,
is_pinned?: boolean
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### get
`stories.get`
Get a story by GID
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### update
`stories.update`
Update a story
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
text?: string,
html_text?: string,
is_pinned?: boolean
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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
}
```
***
## Tags
### create
`tags.create`
Create a tag
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.tags.create({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
name: string,
color?: string,
notes?: string,
workspace?: string,
followers?: string[]
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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
}
```
***
### createInWorkspace
`tags.createInWorkspace`
Create a tag in a workspace
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.tags.createInWorkspace({});
```
**Input**
| Name | Type | Required | Description |
| --------------- | ---------- | -------- | ----------- |
| `workspace_gid` | `string` | Yes | — |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
name: string,
color?: string,
notes?: string,
followers?: string[]
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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
}
```
***
### delete
`tags.delete`
Delete a tag \[DESTRUCTIVE]
**Risk:** `destructive`
```ts theme={null}
await corsair.asana.api.tags.delete({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | --------- | -------- | ----------- |
| `tag_gid` | `string` | Yes | — |
| `opt_pretty` | `boolean` | No | — |
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
}
```
***
### get
`tags.get`
Get a tag by GID
**Risk:** `read`
```ts theme={null}
await corsair.asana.api.tags.get({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `tag_gid` | `string` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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
}
```
***
### getTasks
`tags.getTasks`
Get tasks with a specific tag
**Risk:** `read`
```ts theme={null}
await corsair.asana.api.tags.getTasks({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `tag_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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### list
`tags.list`
List tags
**Risk:** `read`
```ts theme={null}
await corsair.asana.api.tags.list({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForTask
`tags.listForTask`
List tags on a task
**Risk:** `read`
```ts theme={null}
await corsair.asana.api.tags.listForTask({});
```
**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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForWorkspace
`tags.listForWorkspace`
List tags in a workspace
**Risk:** `read`
```ts theme={null}
await corsair.asana.api.tags.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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### update
`tags.update`
Update a tag
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.tags.update({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `tag_gid` | `string` | Yes | — |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
name?: string,
color?: string,
notes?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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
}
```
***
## Tasks
### addDependencies
`tasks.addDependencies`
Add task dependencies
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string
}[]
```
***
### addFollowers
`tasks.addFollowers`
Add followers to a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string
}
```
***
### addProject
`tasks.addProject`
Add a task to a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### addTag
`tasks.addTag`
Add a tag to a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### addToSection
`tasks.addToSection`
Add a task to a section
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### create
`tasks.create`
Create a new task
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.tasks.create({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
name?: string,
notes?: string,
assignee?: string,
due_on?: string,
due_at?: string,
completed?: boolean
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### duplicate
`tasks.duplicate`
Duplicate a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
name?: string,
include?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### getStories
`tasks.getStories`
Get stories (activity) for a task
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### getSubtasks
`tasks.getSubtasks`
Get subtasks of a task
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### getTags
`tasks.getTags`
Get tags on a task
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### list
`tasks.list`
List tasks
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### removeFollower
`tasks.removeFollower`
Remove a follower from a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string
}
```
***
### removeProject
`tasks.removeProject`
Remove a task from a project
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### removeTag
`tasks.removeTag`
Remove a tag from a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### search
`tasks.search`
Search tasks in a workspace
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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?: {
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### setParent
`tasks.setParent`
Set the parent of a task
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
name: string,
description?: string,
html_description?: string,
visibility?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForWorkspace
`teams.listForWorkspace`
List teams in a workspace
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### membershipsGet
`teams.membershipsGet`
Get a team membership
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### membershipsListForTeam
`teams.membershipsListForTeam`
List memberships for a team
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### membershipsListForUser
`teams.membershipsListForUser`
List team memberships for a user
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### removeUser
`teams.removeUser`
Remove a user from a team
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
}
```
***
### update
`teams.update`
Update a team
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
name?: string,
description?: string,
html_description?: string,
visibility?: string
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string
}[]
```
***
### getTaskList
`users.getTaskList`
Get a user's task list
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
email?: string,
resource_type?: string,
photo?: {
} | null,
workspaces?: {
gid: string,
name?: string,
resource_type?: string
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForTeam
`users.listForTeam`
List users in a team
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
email?: string,
resource_type?: string,
photo?: {
} | null,
workspaces?: {
gid: string,
name?: string,
resource_type?: string
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### listForWorkspace
`users.listForWorkspace`
List users in a workspace
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
email?: string,
resource_type?: string,
photo?: {
} | null,
workspaces?: {
gid: string,
name?: string,
resource_type?: string
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
## Webhook Management
### create
`webhookManagement.create`
Register a new webhook
**Risk:** `write`
```ts theme={null}
await corsair.asana.api.webhookManagement.create({});
```
**Input**
| Name | Type | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `data` | `object` | Yes | — |
| `opt_fields` | `string[]` | No | — |
| `opt_pretty` | `boolean` | No | — |
```ts theme={null}
{
resource: string,
target: string,
filters?: {
resource_type?: string,
resource_subtype?: string,
action?: string,
fields?: string[]
}[]
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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[]
}[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### update
`webhookManagement.update`
Update a webhook
**Risk:** `write`
```ts theme={null}
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 | — |
```ts theme={null}
{
filters?: {
resource_type?: string,
resource_subtype?: string,
action?: string,
fields?: string[]
}[]
}
```
**Output**
| Name | Type | Required | Description |
| ------ | -------- | -------- | ----------- |
| `data` | `object` | No | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string,
is_organization?: boolean,
email_domains?: string[]
}
```
***
### list
`workspaces.list`
List workspaces
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
gid: string,
name?: string,
resource_type?: string,
is_organization?: boolean,
email_domains?: string[]
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### membershipsGet
`workspaces.membershipsGet`
Get a workspace membership
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***
### membershipsListForUser
`workspaces.membershipsListForUser`
List workspace memberships for a user
**Risk:** `read`
```ts theme={null}
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 | — |
```ts theme={null}
{
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
}
}[]
```
```ts theme={null}
{
offset?: string,
path?: string,
uri?: string
}
```
***