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

# Teamwork API reference

> API reference for the Teamwork plugin in Corsair: every `teamwork.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Board Cards

### delete

`boardCards.delete`

Remove a card from the board.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.boardCards.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`boardCards.get`

Get one board card.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.boardCards.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `card` | `object \| null` | No | — |

> [accordion] card full type
>
> ```ts theme={null}
> {
>   dueDate?: string | number | boolean | null,
>   canComplete?: string | number | boolean | null,
>   numComments?: string | number | boolean | null,
>   taskListId?: string | number | boolean | null,
>   displayOrder?: string | number | boolean | null,
>   hasTickets?: string | number | boolean | null,
>   archived?: string | number | boolean | null,
>   deletedDate?: string | number | boolean | null,
>   dateCompleted?: string | number | boolean | null,
>   dateUpdated?: string | number | boolean | null,
>   private?: string | number | boolean | null,
>   projectId?: string | number | boolean | null,
>   status?: string | number | boolean | null,
>   numPredecessors?: string | number | boolean | null,
>   numDependencies?: string | number | boolean | null,
>   numAttachments?: string | number | boolean | null,
>   tags?: (
>     {
>     } | null
>   )[] | null,
>   canEdit?: string | number | boolean | null,
>   startDate?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   hasLoggedTime?: string | number | boolean | null,
>   dateCreated?: string | number | boolean | null,
>   completed?: string | number | boolean | null,
>   estimatedMinutes?: string | number | boolean | null,
>   deleted?: string | number | boolean | null,
>   taskStatus?: string | number | boolean | null,
>   taskListName?: string | number | boolean | null,
>   columnId?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   progress?: string | number | boolean | null,
>   priority?: string | number | boolean | null,
>   projectName?: string | number | boolean | null,
>   hasReminders?: string | number | boolean | null,
>   parentTaskId?: string | number | boolean | null,
>   column?: {
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     color?: string | number | boolean | null
>   } | null,
>   hasRemindersForUser?: string | number | boolean | null,
>   numActiveSubTasks?: string | number | boolean | null,
>   assignedPeople?: (string | number | boolean | null)[] | null,
>   taskId?: string | number | boolean | null,
>   isRecurring?: string | number | boolean | null,
>   hasUnreadComments?: string | number | boolean | null,
>   archivedDate?: string | number | boolean | null
> } | null
> ```

***

### list

`boardCards.list`

List the cards in a board column.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.boardCards.list({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   pageSize?: number,
>   showDeleted?: boolean,
>   deletedAfterDate?: string,
>   updatedAfterDate?: string,
>   searchTerm?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `people` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `column` | `object \| null` | No | — |
| `cards` | `object[] \| null` | No | — |

> [accordion] people full type
>
> ```ts theme={null}
> {
>   12345?: {
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     avatarUrl?: string | number | boolean | null,
>     firstName?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     lastName?: string | number | boolean | null
>   } | null
> } | null
> ```

> [accordion] column full type
>
> ```ts theme={null}
> {
>   name?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   color?: string | number | boolean | null
> } | null
> ```

> [accordion] cards full type
>
> ```ts theme={null}
> (
>   {
>     dueDate?: string | number | boolean | null,
>     canComplete?: string | number | boolean | null,
>     numComments?: string | number | boolean | null,
>     taskListId?: string | number | boolean | null,
>     displayOrder?: string | number | boolean | null,
>     hasTickets?: string | number | boolean | null,
>     archived?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     dateCompleted?: string | number | boolean | null,
>     private?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     status?: string | number | boolean | null,
>     numPredecessors?: string | number | boolean | null,
>     numDependencies?: string | number | boolean | null,
>     numAttachments?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     tags?: (
>       {
>       } | null
>     )[] | null,
>     startDate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     hasLoggedTime?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     completed?: string | number | boolean | null,
>     estimatedMinutes?: string | number | boolean | null,
>     deleted?: string | number | boolean | null,
>     taskListName?: string | number | boolean | null,
>     taskStatus?: string | number | boolean | null,
>     columnId?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     priority?: string | number | boolean | null,
>     progress?: string | number | boolean | null,
>     parentTaskId?: string | number | boolean | null,
>     numActiveSubTasks?: string | number | boolean | null,
>     assignedPeople?: (string | number | boolean | null)[] | null,
>     taskId?: string | number | boolean | null,
>     isRecurring?: string | number | boolean | null,
>     hasUnreadComments?: string | number | boolean | null,
>     archivedDate?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### move

`boardCards.move`

Move a card to another column.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.boardCards.move({
	path: { id: 1 },
	body: { cardId: 1, columnId: 2, positionAfterId: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cardId?: number,
>   positionAfterId?: number,
>   columnId?: number
> }
> ```

**Output:** *empty object*

***

### update

`boardCards.update`

Update a board card.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.boardCards.update({
	path: { id: '1' },
	body: {
		card: { due-date: '20261130', priority: 'high' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   card?: {
>     content?: string,
>     taskListId?: string,
>     start-date?: string,
>     due-date?: string,
>     responsible-party-id?: string,
>     estimated-minutes?: number,
>     priority?: string,
>     progress?: string,
>     tags?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Board Columns

### create

`boardColumns.create`

Create a board column.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.boardColumns.create({
	path: { id: 1470497 },
	body: {
		column: { name: 'In review', color: '#4461D7' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   column?: {
>     name?: string,
>     color?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`boardColumns.delete`

Delete a board column.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.boardColumns.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`boardColumns.get`

Get one board column.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.boardColumns.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `column` | `object \| null` | No | — |

> [accordion] column full type
>
> ```ts theme={null}
> {
>   name?: string | number | boolean | null,
>   displayOrder?: string | number | boolean | null,
>   sortOrder?: string | number | boolean | null,
>   deletedDate?: string | number | boolean | null,
>   dateUpdated?: string | number | boolean | null,
>   settings?: {
>     time?: string | number | boolean | null,
>     avatar?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     files?: string | number | boolean | null,
>     comments?: string | number | boolean | null,
>     priority?: string | number | boolean | null,
>     progress?: string | number | boolean | null,
>     subtasktext?: string | number | boolean | null,
>     tasklist?: string | number | boolean | null,
>     private?: string | number | boolean | null,
>     reminders?: string | number | boolean | null,
>     assignee?: string | number | boolean | null,
>     dependencies?: string | number | boolean | null,
>     tags?: string | number | boolean | null,
>     estimatedtime?: string | number | boolean | null,
>     startdate?: string | number | boolean | null,
>     tickets?: string | number | boolean | null,
>     followers?: string | number | boolean | null,
>     recurring?: string | number | boolean | null,
>     subtasklabel?: string | number | boolean | null,
>     enddate?: string | number | boolean | null
>   } | null,
>   defaultTasklist?: {
>     newTaskDefaults?: {
>     } | null,
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null,
>   projectId?: string | number | boolean | null,
>   hasTriggers?: string | number | boolean | null,
>   sort?: string | number | boolean | null,
>   canEdit?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   dateCreated?: string | number | boolean | null,
>   color?: string | number | boolean | null,
>   deleted?: string | number | boolean | null,
>   canAddCards?: string | number | boolean | null
> } | null
> ```

***

### list

`boardColumns.list`

List the board columns of a project (needs Boards on for the project).

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.boardColumns.list({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   pageSize?: number,
>   showDeleted?: boolean,
>   sortBy?: string,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   includeDefaults?: boolean,
>   get?: string,
>   updatedAfterDate?: string,
>   getStats?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `columns` | `object[] \| null` | No | — |
| `people` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] columns full type
>
> ```ts theme={null}
> (
>   {
>     name?: string | number | boolean | null,
>     displayOrder?: string | number | boolean | null,
>     sortOrder?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     settings?: {
>       avatar?: string | number | boolean | null,
>       time?: string | number | boolean | null,
>       name?: string | number | boolean | null,
>       files?: string | number | boolean | null,
>       comments?: string | number | boolean | null,
>       priority?: string | number | boolean | null,
>       progress?: string | number | boolean | null,
>       subtasktext?: string | number | boolean | null,
>       tasklist?: string | number | boolean | null,
>       private?: string | number | boolean | null,
>       reminders?: string | number | boolean | null,
>       assignee?: string | number | boolean | null,
>       dependencies?: string | number | boolean | null,
>       tags?: string | number | boolean | null,
>       estimatedtime?: string | number | boolean | null,
>       startdate?: string | number | boolean | null,
>       tickets?: string | number | boolean | null,
>       followers?: string | number | boolean | null,
>       recurring?: string | number | boolean | null,
>       subtasklabel?: string | number | boolean | null,
>       parenttask?: string | number | boolean | null,
>       enddate?: string | number | boolean | null
>     } | null,
>     defaultTasklist?: {
>       newTaskDefaults?: {
>       } | null,
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     projectId?: string | number | boolean | null,
>     stats?: {
>       estimatedTime?: string | number | boolean | null,
>       total?: string | number | boolean | null,
>       completed?: string | number | boolean | null,
>       active?: string | number | boolean | null
>     } | null,
>     hasTriggers?: string | number | boolean | null,
>     sort?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     triggers?: (
>       {
>       } | null
>     )[] | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     color?: string | number | boolean | null,
>     deleted?: string | number | boolean | null,
>     canAddCards?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] people full type
>
> ```ts theme={null}
> {
>   123?: {
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     avatarUrl?: string | number | boolean | null,
>     firstName?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     lastName?: string | number | boolean | null
>   } | null
> } | null
> ```

***

### update

`boardColumns.update`

Update a board column.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.boardColumns.update({
	path: { id: '1' },
	body: {
		column: { name: 'Ready to ship' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   column?: {
>     name?: string,
>     color?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Comments

### create

`comments.create`

Comment on a task, milestone, file, notebook or link. Teamwork notifies the people in notify.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.comments.create({
	path: { resource: 'tasks', resourceId: '51453032' },
	body: {
		comment: { body: 'Looks good, ship it.', notify: '' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   resource: string,
>   resourceId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment?: {
>     body?: string,
>     notify?: string,
>     isprivate?: boolean,
>     pendingFileAttachments?: string,
>     content-type?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`comments.delete`

Delete a comment.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.comments.delete({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`comments.get`

Get one comment.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.comments.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   publishedStartDate?: string,
>   publishedEndDate?: string,
>   projectType?: string,
>   projectStatuses?: string,
>   orderMode?: asc | desc,
>   orderBy?: all | date | project | user | type | id,
>   cursor?: string,
>   commentStatus?: all | read | unread,
>   pageSize?: number,
>   page?: number,
>   limit?: number,
>   strictHTML?: boolean,
>   skipCounts?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   userIds?: number[],
>   projectTagIds?: number[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   objectTypes?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectType?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectIds?: number[],
>   notifiedUserIds?: number[],
>   include?: (reactions | users | projects | projects.companies | files | relatedFiles | tasks | notebooks | milestones | links)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     links
>   ]?: (id | title | description | code | width | height | isPrivate | provider | projectId | createdAt | forceNewWindow | deleted | deletedAt | updatedAt | categoryId | createdBy | deletedBy | updatedBy | project)[],
>   fields[
>     fileversions
>   ]?: (fileVersionId | fileId | versionNo | name | originalName | size | uploadedBy | uploadedAt | description | status | projectId | reactions | commentsCount | commentsCountRead | displayName)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   commentIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `comments` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |

> [accordion] comments full type
>
> ```ts theme={null}
> {
>   body?: string | null,
>   commentLink?: string | null,
>   contentType?: string | null,
>   dateDeleted?: string | null,
>   dateLastEdited?: string | null,
>   deleted?: boolean | null,
>   deletedBy?: number | null,
>   deletedByUserId?: number | null,
>   fileCount?: number | null,
>   fileIds?: (number | null)[] | null,
>   files?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   htmlBody?: string | null,
>   id?: number | null,
>   installation?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   installationId?: number | null,
>   isPrivate?: number | null,
>   lastEditedBy?: number | null,
>   lastEditedByUserId?: number | null,
>   lockdownID?: number | null,
>   meta?: {
>     isRead?: boolean | null,
>     permissions?: {
>       canDelete?: boolean | null,
>       canEdit?: boolean | null
>     } | null
>   } | null,
>   object?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   objectId?: number | null,
>   objectType?: string | null,
>   peopleNotifiedCount?: number | null,
>   postedBy?: number | null,
>   postedByUserId?: number | null,
>   postedDateTime?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   reactions?: (
>     {
>       emoji?: string | null,
>       installation?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       installationId?: number | null,
>       object?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       objectId?: number | null,
>       objectType?: string | null,
>       postedDateTime?: string | null,
>       type?: string | null,
>       user?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       userId?: number | null
>     } | null
>   )[] | null,
>   reactionsCount?: number | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   files?: {
>   } | null,
>   fileversions?: {
>   } | null,
>   links?: {
>   } | null,
>   milestones?: {
>   } | null,
>   notebooks?: {
>   } | null,
>   projects?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

***

### list

`comments.list`

List comments across tasks, milestones, files, notebooks and links. Filter with objectIds, projectIds, userIds.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.comments.list({
	query: {
		objectIds: [51453032],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   publishedStartDate?: string,
>   publishedEndDate?: string,
>   projectType?: string,
>   projectStatuses?: string,
>   orderMode?: asc | desc,
>   orderBy?: all | date | project | user | type | id,
>   cursor?: string,
>   commentStatus?: all | read | unread,
>   pageSize?: number,
>   page?: number,
>   limit?: number,
>   strictHTML?: boolean,
>   skipCounts?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   userIds?: number[],
>   projectTagIds?: number[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   objectTypes?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectType?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectIds?: number[],
>   notifiedUserIds?: number[],
>   include?: (reactions | users | projects | projects.companies | files | relatedFiles | tasks | notebooks | milestones | links)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     links
>   ]?: (id | title | description | code | width | height | isPrivate | provider | projectId | createdAt | forceNewWindow | deleted | deletedAt | updatedAt | categoryId | createdBy | deletedBy | updatedBy | project)[],
>   fields[
>     fileversions
>   ]?: (fileVersionId | fileId | versionNo | name | originalName | size | uploadedBy | uploadedAt | description | status | projectId | reactions | commentsCount | commentsCountRead | displayName)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   commentIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `comments` | `object[] \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] comments full type
>
> ```ts theme={null}
> (
>   {
>     body?: string | null,
>     commentLink?: string | null,
>     contentType?: string | null,
>     dateDeleted?: string | null,
>     dateLastEdited?: string | null,
>     deleted?: boolean | null,
>     deletedBy?: number | null,
>     deletedByUserId?: number | null,
>     fileCount?: number | null,
>     fileIds?: (number | null)[] | null,
>     files?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     htmlBody?: string | null,
>     id?: number | null,
>     installation?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     installationId?: number | null,
>     isPrivate?: number | null,
>     lastEditedBy?: number | null,
>     lastEditedByUserId?: number | null,
>     lockdownID?: number | null,
>     meta?: {
>       isRead?: boolean | null,
>       permissions?: {
>         canDelete?: boolean | null,
>         canEdit?: boolean | null
>       } | null
>     } | null,
>     object?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     objectId?: number | null,
>     objectType?: string | null,
>     peopleNotifiedCount?: number | null,
>     postedBy?: number | null,
>     postedByUserId?: number | null,
>     postedDateTime?: string | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     reactions?: (
>       {
>         emoji?: string | null,
>         installation?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         installationId?: number | null,
>         object?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         objectId?: number | null,
>         objectType?: string | null,
>         postedDateTime?: string | null,
>         type?: string | null,
>         user?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         userId?: number | null
>       } | null
>     )[] | null,
>     reactionsCount?: number | null
>   } | null
> )[] | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   files?: {
>   } | null,
>   fileversions?: {
>   } | null,
>   links?: {
>   } | null,
>   milestones?: {
>   } | null,
>   notebooks?: {
>   } | null,
>   projects?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### listNotified

`comments.listNotified`

List the users notified about a comment.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.comments.listNotified({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   publishedStartDate?: string,
>   publishedEndDate?: string,
>   projectType?: string,
>   projectStatuses?: string,
>   orderMode?: asc | desc,
>   orderBy?: all | date | project | user | type | id,
>   cursor?: string,
>   commentStatus?: all | read | unread,
>   pageSize?: number,
>   page?: number,
>   limit?: number,
>   strictHTML?: boolean,
>   skipCounts?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   userIds?: number[],
>   projectTagIds?: number[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   objectTypes?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectType?: (task | file | fileversion | notebook | milestone | link | projectupdate | customitemrecord)[],
>   objectIds?: number[],
>   notifiedUserIds?: number[],
>   include?: (reactions | users | projects | projects.companies | files | relatedFiles | tasks | notebooks | milestones | links)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     links
>   ]?: (id | title | description | code | width | height | isPrivate | provider | projectId | createdAt | forceNewWindow | deleted | deletedAt | updatedAt | categoryId | createdBy | deletedBy | updatedBy | project)[],
>   fields[
>     fileversions
>   ]?: (fileVersionId | fileId | versionNo | name | originalName | size | uploadedBy | uploadedAt | description | status | projectId | reactions | commentsCount | commentsCountRead | displayName)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   commentIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `people` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] people full type
>
> ```ts theme={null}
> (
>   {
>     avatarUrl?: string | null,
>     canAccessPortfolio?: boolean | null,
>     canAddProjects?: boolean | null,
>     canManagePortfolio?: boolean | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     companyRoleId?: number | null,
>     createdAt?: string | null,
>     createdBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     deleted?: boolean | null,
>     email?: string | null,
>     firstName?: string | null,
>     id?: number | null,
>     inOwnerCompany?: boolean | null,
>     isAdmin?: boolean | null,
>     isClientUser?: boolean | null,
>     isPlaceholderResource?: boolean | null,
>     isServiceAccount?: boolean | null,
>     jobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     lastLogin?: string | null,
>     lastName?: string | null,
>     lengthOfDay?: number | null,
>     linkedClientPortalCompany?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     linkedClientPortalCompanyId?: number | null,
>     loginTarget?: string | null,
>     meta?: {
>     } | null,
>     siteOwner?: boolean | null,
>     skills?: (
>       {
>         id?: number | null,
>         meta?: {
>           level?: number | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     timezone?: string | null,
>     type?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userCost?: number | null,
>     userRate?: number | null,
>     userRates?: {
>     } | null,
>     workingHour?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     workingHoursId?: number | null
>   } | null
> )[] | null
> ```

***

### markRead

`comments.markRead`

Mark a comment as read.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.comments.markRead({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`comments.update`

Edit a comment.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.comments.update({
	path: { id: 1 },
	body: {
		comment: { body: 'Looks good, ship it Monday.', notify: '' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment: {
>     body: string,
>     notify?: string,
>     isprivate?: boolean,
>     pendingFileAttachments?: string,
>     content-type?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Companies

### addDomains

`companies.addDomains`

Add email domains to a company.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.companies.addDomains({
	path: { id: 1 },
	body: {
		companyDomains: [{ domain: 'acme.example', companyId: 1 }],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   companyDomains?: {
>     companyId?: number,
>     domain?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `domains` | `object[] \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] domains full type
>
> ```ts theme={null}
> (
>   {
>     companyId?: number | null,
>     createdAt?: string | null,
>     createdByUser?: number | null,
>     deletedAt?: string | null,
>     deletedByUser?: number | null,
>     domain?: string | null,
>     id?: number | null,
>     state?: string | null,
>     updatedAt?: string | null,
>     updatedByUser?: number | null
>   } | null
> )[] | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### convertCurrency

`companies.convertCurrency`

Convert a company's currency, rewriting its rates and budgets.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.companies.convertCurrency({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### create

`companies.create`

Create a company.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.companies.create({
	body: {
		company: { name: 'Acme Inc', website: 'https://acme.example' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company?: {
>     addressOne?: string,
>     addressTwo?: string,
>     cid?: string,
>     city?: string,
>     clientManagedBy?: number,
>     countrycode?: string,
>     currencyId?: number,
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId?: number,
>         urlTextToDisplay?: string,
>         value?: any
>       }[]
>     },
>     emailOne?: string,
>     emailThree?: string,
>     emailTwo?: string,
>     fax?: string,
>     industryCatId?: number,
>     logoPendingFileRef?: string,
>     name?: string,
>     phone?: string,
>     privateNotes?: string,
>     profile?: string,
>     removeLogo?: boolean,
>     state?: string,
>     tagIds?: number[],
>     website?: string,
>     zip?: string
>   },
>   companyOptions?: {
>     fireWebhook?: boolean,
>     logActivity?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `company` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] company full type
>
> ```ts theme={null}
> {
>   accounts?: number | null,
>   addressOne?: string | null,
>   addressTwo?: string | null,
>   budgetDistribution?: (
>     {
>       color?: string | null,
>       companyId?: number | null,
>       count?: number | null,
>       from?: number | null,
>       to?: number | null
>     } | null
>   )[] | null,
>   canSeePrivate?: boolean | null,
>   cid?: string | null,
>   city?: string | null,
>   clientManagedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   clientPortals?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   clients?: number | null,
>   collaborators?: number | null,
>   companyDomains?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   companyNameUrl?: string | null,
>   companyUpdate?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   contacts?: number | null,
>   countryCode?: string | null,
>   createdAt?: string | null,
>   currency?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   emailOne?: string | null,
>   emailThree?: string | null,
>   emailTwo?: string | null,
>   fax?: string | null,
>   financialBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   id?: number | null,
>   industry?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   industryId?: number | null,
>   isOwner?: boolean | null,
>   logoUrl?: string | null,
>   name?: string | null,
>   phone?: string | null,
>   privateNotes?: string | null,
>   privateNotesText?: string | null,
>   profileText?: string | null,
>   profitability?: {
>     billable?: number | null,
>     billableTime?: number | null,
>     billableTimeFinancial?: number | null,
>     companyCount?: number | null,
>     cost?: number | null,
>     expenses?: number | null,
>     expensesBillableTotal?: number | null,
>     loggedTime?: number | null,
>     nonBillableTime?: number | null,
>     ownerCount?: number | null,
>     profit?: number | null,
>     profitPercentage?: number | null,
>     profitTargetPercentage?: number | null,
>     revenueTimeBased?: number | null,
>     targetCostsDollars?: number | null,
>     targetProfitDollars?: number | null
>   } | null,
>   rates?: (
>     {
>       createdAt?: string | null,
>       createdByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       role?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       updatedAt?: string | null,
>       updatedByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   state?: string | null,
>   stats?: {
>     projectCount?: number | null,
>     taskCompleteCount?: number | null,
>     taskCount?: number | null,
>     unreadEmailCount?: number | null
>   } | null,
>   status?: string | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timeBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   updatedAt?: string | null,
>   website?: string | null,
>   zip?: string | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   clientPortals?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldCompanies?: {
>   } | null,
>   customfields?: {
>   } | null,
>   domains?: {
>   } | null,
>   industries?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   tags?: {
>   } | null,
>   updates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### delete

`companies.delete`

Delete a company.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.companies.delete({
	path: { companyId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   companyId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### deleteDomain

`companies.deleteDomain`

Delete a company email domain.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.companies.deleteDomain({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### get

`companies.get`

Get one company.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.companies.get({
	path: { companyId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   companyId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   reportType?: company | client,
>   reportFormat?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | accounts | clients | collaborators | contacts | projects | tasks | country | health | website | email | phone | fax | industry | ownercompany | ownername | taskscompletion | customfield | id | namecaseinsensitive | createdAt | updatedAt,
>   name?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   firstLetter?: string,
>   createdAfterDate?: string,
>   createdAfter?: string,
>   budgetRanges?: string,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   currencyId?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchClientManagers?: boolean,
>   returnLetters?: boolean,
>   onlyUntaggedCompanies?: boolean,
>   matchAllTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUntaggedCompanies?: boolean,
>   includeTentativeProjects?: boolean,
>   includeProfitability?: boolean,
>   includePermissions?: boolean,
>   includeCustomFields?: boolean,
>   includeBudgetSummary?: boolean,
>   includeBudgetDistribution?: boolean,
>   getStats?: boolean,
>   getEmoji?: boolean,
>   fullProfile?: boolean,
>   excludeOwnerCompany?: boolean,
>   tagIds?: number[],
>   selectedColumns?: string[],
>   projectStatuses?: string[],
>   notLinkedWithClientPortalIds?: number[],
>   include?: (tags | countries | industries | clientmanagedby | companyupdates | jobRoles | users | companydomains | currencies | customfields | customfieldCompanies | clientPortals)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   excludeTagIds?: number[],
>   excludeIds?: number[],
>   companyHealths?: number[],
>   clientManagedByUserIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `company` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] company full type
>
> ```ts theme={null}
> {
>   accounts?: number | null,
>   addressOne?: string | null,
>   addressTwo?: string | null,
>   budgetDistribution?: (
>     {
>       color?: string | null,
>       companyId?: number | null,
>       count?: number | null,
>       from?: number | null,
>       to?: number | null
>     } | null
>   )[] | null,
>   canSeePrivate?: boolean | null,
>   cid?: string | null,
>   city?: string | null,
>   clientManagedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   clientPortals?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   clients?: number | null,
>   collaborators?: number | null,
>   companyDomains?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   companyNameUrl?: string | null,
>   companyUpdate?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   contacts?: number | null,
>   countryCode?: string | null,
>   createdAt?: string | null,
>   currency?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   emailOne?: string | null,
>   emailThree?: string | null,
>   emailTwo?: string | null,
>   fax?: string | null,
>   financialBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   id?: number | null,
>   industry?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   industryId?: number | null,
>   isOwner?: boolean | null,
>   logoUrl?: string | null,
>   name?: string | null,
>   phone?: string | null,
>   privateNotes?: string | null,
>   privateNotesText?: string | null,
>   profileText?: string | null,
>   profitability?: {
>     billable?: number | null,
>     billableTime?: number | null,
>     billableTimeFinancial?: number | null,
>     companyCount?: number | null,
>     cost?: number | null,
>     expenses?: number | null,
>     expensesBillableTotal?: number | null,
>     loggedTime?: number | null,
>     nonBillableTime?: number | null,
>     ownerCount?: number | null,
>     profit?: number | null,
>     profitPercentage?: number | null,
>     profitTargetPercentage?: number | null,
>     revenueTimeBased?: number | null,
>     targetCostsDollars?: number | null,
>     targetProfitDollars?: number | null
>   } | null,
>   rates?: (
>     {
>       createdAt?: string | null,
>       createdByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       role?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       updatedAt?: string | null,
>       updatedByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   state?: string | null,
>   stats?: {
>     projectCount?: number | null,
>     taskCompleteCount?: number | null,
>     taskCount?: number | null,
>     unreadEmailCount?: number | null
>   } | null,
>   status?: string | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timeBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   updatedAt?: string | null,
>   website?: string | null,
>   zip?: string | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   clientPortals?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldCompanies?: {
>   } | null,
>   customfields?: {
>   } | null,
>   domains?: {
>   } | null,
>   industries?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   tags?: {
>   } | null,
>   updates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### list

`companies.list`

List companies.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.companies.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   reportType?: company | client,
>   reportFormat?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | accounts | clients | collaborators | contacts | projects | tasks | country | health | website | email | phone | fax | industry | ownercompany | ownername | taskscompletion | customfield | id | namecaseinsensitive | createdAt | updatedAt,
>   name?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   firstLetter?: string,
>   createdAfterDate?: string,
>   createdAfter?: string,
>   budgetRanges?: string,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   currencyId?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchClientManagers?: boolean,
>   returnLetters?: boolean,
>   onlyUntaggedCompanies?: boolean,
>   matchAllTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUntaggedCompanies?: boolean,
>   includeTentativeProjects?: boolean,
>   includeProfitability?: boolean,
>   includePermissions?: boolean,
>   includeCustomFields?: boolean,
>   includeBudgetSummary?: boolean,
>   includeBudgetDistribution?: boolean,
>   getStats?: boolean,
>   getEmoji?: boolean,
>   fullProfile?: boolean,
>   excludeOwnerCompany?: boolean,
>   tagIds?: number[],
>   selectedColumns?: string[],
>   projectStatuses?: string[],
>   notLinkedWithClientPortalIds?: number[],
>   include?: (tags | countries | industries | clientmanagedby | companyupdates | jobRoles | users | companydomains | currencies | customfields | customfieldCompanies | clientPortals)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   excludeTagIds?: number[],
>   excludeIds?: number[],
>   companyHealths?: number[],
>   clientManagedByUserIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `companies` | `object[] \| null` | No | — |
| `included` | `object \| null` | No | — |
| `letters` | `(string \| null)[] \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] companies full type
>
> ```ts theme={null}
> (
>   {
>     accounts?: number | null,
>     addressOne?: string | null,
>     addressTwo?: string | null,
>     budgetDistribution?: (
>       {
>         color?: string | null,
>         companyId?: number | null,
>         count?: number | null,
>         from?: number | null,
>         to?: number | null
>       } | null
>     )[] | null,
>     canSeePrivate?: boolean | null,
>     cid?: string | null,
>     city?: string | null,
>     clientManagedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     clientPortals?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     clients?: number | null,
>     collaborators?: number | null,
>     companyDomains?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyNameUrl?: string | null,
>     companyUpdate?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     contacts?: number | null,
>     countryCode?: string | null,
>     createdAt?: string | null,
>     currency?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     emailOne?: string | null,
>     emailThree?: string | null,
>     emailTwo?: string | null,
>     fax?: string | null,
>     financialBudgetSummary?: {
>       totalCapacity?: number | null,
>       totalCapacityUsed?: number | null
>     } | null,
>     id?: number | null,
>     industry?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     industryId?: number | null,
>     isOwner?: boolean | null,
>     logoUrl?: string | null,
>     name?: string | null,
>     phone?: string | null,
>     privateNotes?: string | null,
>     privateNotesText?: string | null,
>     profileText?: string | null,
>     profitability?: {
>       billable?: number | null,
>       billableTime?: number | null,
>       billableTimeFinancial?: number | null,
>       companyCount?: number | null,
>       cost?: number | null,
>       expenses?: number | null,
>       expensesBillableTotal?: number | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       ownerCount?: number | null,
>       profit?: number | null,
>       profitPercentage?: number | null,
>       profitTargetPercentage?: number | null,
>       revenueTimeBased?: number | null,
>       targetCostsDollars?: number | null,
>       targetProfitDollars?: number | null
>     } | null,
>     rates?: (
>       {
>         createdAt?: string | null,
>         createdByUser?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         rate?: {
>           amount?: number | null,
>           currency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null,
>         role?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         updatedAt?: string | null,
>         updatedByUser?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null
>     )[] | null,
>     state?: string | null,
>     stats?: {
>       projectCount?: number | null,
>       taskCompleteCount?: number | null,
>       taskCount?: number | null,
>       unreadEmailCount?: number | null
>     } | null,
>     status?: string | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     timeBudgetSummary?: {
>       totalCapacity?: number | null,
>       totalCapacityUsed?: number | null
>     } | null,
>     updatedAt?: string | null,
>     website?: string | null,
>     zip?: string | null
>   } | null
> )[] | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   clientPortals?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldCompanies?: {
>   } | null,
>   customfields?: {
>   } | null,
>   domains?: {
>   } | null,
>   industries?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   tags?: {
>   } | null,
>   updates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### listForProject

`companies.listForProject`

List the companies on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.companies.listForProject({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `companies` | `object[] \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] companies full type
>
> ```ts theme={null}
> (
>   {
>     state?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     address_two?: string | number | boolean | null,
>     email_one?: string | number | boolean | null,
>     country?: string | number | boolean | null,
>     isowner?: string | number | boolean | null,
>     email_three?: string | number | boolean | null,
>     contacts?: string | number | boolean | null,
>     industry?: string | number | boolean | null,
>     logo-URL?: string | number | boolean | null,
>     address_one?: string | number | boolean | null,
>     website?: string | number | boolean | null,
>     cid?: string | number | boolean | null,
>     email_two?: string | number | boolean | null,
>     accounts?: string | number | boolean | null,
>     phone?: string | number | boolean | null,
>     company_name_url?: string | number | boolean | null,
>     countrycode?: string | number | boolean | null,
>     can_see_private?: string | number | boolean | null,
>     zip?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     city?: string | number | boolean | null,
>     fax?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### setRates

`companies.setRates`

Set a company's client rates per role.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.companies.setRates({
	path: { companyId: 1 },
	body: {
		clientRateByRoleId: {},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   companyId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   clientRateByRoleId?: {
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `clientRateByRoleId` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |

> [accordion] clientRateByRoleId full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   currencies?: {
>   } | null
> } | null
> ```

***

### update

`companies.update`

Update a company.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.companies.update({
	path: { companyId: 1 },
	body: {
		company: { website: 'https://acme.example' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   companyId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company?: {
>     addressOne?: string,
>     addressTwo?: string,
>     cid?: string,
>     city?: string,
>     clientManagedBy?: number,
>     countrycode?: string,
>     currencyId?: number,
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId?: number,
>         urlTextToDisplay?: string,
>         value?: any
>       }[]
>     },
>     emailOne?: string,
>     emailThree?: string,
>     emailTwo?: string,
>     fax?: string,
>     industryCatId?: number,
>     logoPendingFileRef?: string,
>     name?: string,
>     phone?: string,
>     privateNotes?: string,
>     profile?: string,
>     removeLogo?: boolean,
>     state?: string,
>     tagIds?: number[],
>     website?: string,
>     zip?: string
>   },
>   companyOptions?: {
>     fireWebhook?: boolean,
>     logActivity?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `company` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] company full type
>
> ```ts theme={null}
> {
>   accounts?: number | null,
>   addressOne?: string | null,
>   addressTwo?: string | null,
>   budgetDistribution?: (
>     {
>       color?: string | null,
>       companyId?: number | null,
>       count?: number | null,
>       from?: number | null,
>       to?: number | null
>     } | null
>   )[] | null,
>   canSeePrivate?: boolean | null,
>   cid?: string | null,
>   city?: string | null,
>   clientManagedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   clientPortals?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   clients?: number | null,
>   collaborators?: number | null,
>   companyDomains?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   companyNameUrl?: string | null,
>   companyUpdate?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   contacts?: number | null,
>   countryCode?: string | null,
>   createdAt?: string | null,
>   currency?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   emailOne?: string | null,
>   emailThree?: string | null,
>   emailTwo?: string | null,
>   fax?: string | null,
>   financialBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   id?: number | null,
>   industry?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   industryId?: number | null,
>   isOwner?: boolean | null,
>   logoUrl?: string | null,
>   name?: string | null,
>   phone?: string | null,
>   privateNotes?: string | null,
>   privateNotesText?: string | null,
>   profileText?: string | null,
>   profitability?: {
>     billable?: number | null,
>     billableTime?: number | null,
>     billableTimeFinancial?: number | null,
>     companyCount?: number | null,
>     cost?: number | null,
>     expenses?: number | null,
>     expensesBillableTotal?: number | null,
>     loggedTime?: number | null,
>     nonBillableTime?: number | null,
>     ownerCount?: number | null,
>     profit?: number | null,
>     profitPercentage?: number | null,
>     profitTargetPercentage?: number | null,
>     revenueTimeBased?: number | null,
>     targetCostsDollars?: number | null,
>     targetProfitDollars?: number | null
>   } | null,
>   rates?: (
>     {
>       createdAt?: string | null,
>       createdByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       role?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       updatedAt?: string | null,
>       updatedByUser?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   state?: string | null,
>   stats?: {
>     projectCount?: number | null,
>     taskCompleteCount?: number | null,
>     taskCount?: number | null,
>     unreadEmailCount?: number | null
>   } | null,
>   status?: string | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timeBudgetSummary?: {
>     totalCapacity?: number | null,
>     totalCapacityUsed?: number | null
>   } | null,
>   updatedAt?: string | null,
>   website?: string | null,
>   zip?: string | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   clientPortals?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldCompanies?: {
>   } | null,
>   customfields?: {
>   } | null,
>   domains?: {
>   } | null,
>   industries?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   tags?: {
>   } | null,
>   updates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

### updateDomain

`companies.updateDomain`

Update a company email domain.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.companies.updateDomain({
	path: { id: 1 },
	body: {
		companyDomain: { domain: 'acme.example', companyId: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   companyDomain?: {
>     companyId?: number,
>     domain?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `object \| null` | No | — |

> [accordion] domain full type
>
> ```ts theme={null}
> {
>   companyId?: number | null,
>   createdAt?: string | null,
>   createdByUser?: number | null,
>   deletedAt?: string | null,
>   deletedByUser?: number | null,
>   domain?: string | null,
>   id?: number | null,
>   state?: string | null,
>   updatedAt?: string | null,
>   updatedByUser?: number | null
> } | null
> ```

***

## File Categories

### create

`fileCategories.create`

Create a file category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.fileCategories.create({
	path: { id: '1470497' },
	body: {
		category: { name: 'Contracts' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`fileCategories.delete`

Delete a file category.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.fileCategories.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`fileCategories.get`

Get one file category.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.fileCategories.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `object \| null` | No | — |

> [accordion] category full type
>
> ```ts theme={null}
> {
>   project-id?: string | number | boolean | null,
>   parent-id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   count?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   elements_count?: string | number | boolean | null,
>   type?: string | number | boolean | null
> } | null
> ```

***

### list

`fileCategories.list`

List a project's file categories.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.fileCategories.list({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `categories` | `object[] \| null` | No | — |

> [accordion] categories full type
>
> ```ts theme={null}
> (
>   {
>     project-id?: string | number | boolean | null,
>     parent-id?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     elements_count?: string | number | boolean | null,
>     type?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### update

`fileCategories.update`

Update a file category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.fileCategories.update({
	path: { id: '1' },
	body: {
		category: { name: 'Signed contracts' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Files

### addToProject

`files.addToProject`

Attach an uploaded file (pendingFileRef) to a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.files.addToProject({
	path: { id: '1470497' },
	body: {
		file: { pendingFileRef: 'tf_example-ref', name: 'brief.pdf', notifyCurrentUser: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   file?: {
>     name?: string,
>     private?: number,
>     category-id?: number,
>     category-name?: string,
>     pendingFileRef?: string,
>     tags?: string[],
>     notify?: string,
>     notifyCurrentUser?: boolean,
>     autoNewVersion?: boolean,
>     grant-access-to?: string,
>     tagIds?: number[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### addToTask

`files.addToTask`

Attach an uploaded file (pendingFileRef) to a task.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.files.addToTask({
	path: { id: '51453032' },
	body: {
		task: {
			pendingFileAttachments: ['tf_example-ref'],
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   task?: {
>     pendingFileAttachments?: string[],
>     updateFiles?: boolean,
>     removeOtherFiles?: boolean,
>     attachments?: string,
>     attachmentsCategoryIds?: string,
>     pendingFileAttachmentsCategoryIds?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affectedTaskIds` | `string \| number \| boolean \| null` | No | — |
| `assignedFileIds` | `(string \| number \| boolean \| null)[] \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `existingFileIds` | `(string \| number \| boolean \| null)[] \| null` | No | — |

***

### addVersion

`files.addVersion`

Add a new version to a file.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.files.addVersion({
	path: { id: '1' },
	body: {
		fileversion: { pendingFileRef: 'tf_example-ref' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   fileversion?: {
>     pendingFileRef?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### copy

`files.copy`

Copy a file to another project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.files.copy({
	path: { id: '1' },
	body: { projectId: 1470498 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   projectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`files.delete`

Delete a file.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.files.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### getShareLink

`files.getShareLink`

Get a short share link for a file.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.files.getShareLink({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   version?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `url` | `string \| number \| boolean \| null` | No | — |

***

### listForProject

`files.listForProject`

List the files on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.files.listForProject({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `project` | `object \| null` | No | — |

> [accordion] project full type
>
> ```ts theme={null}
> {
>   company?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   files?: (
>     {
>       project-id?: string | number | boolean | null,
>       uploaded-by-user-last-name?: string | number | boolean | null,
>       name?: string | number | boolean | null,
>       uploaded-date?: string | number | boolean | null,
>       uploaded-by-userId?: string | number | boolean | null,
>       extraData?: string | number | boolean | null,
>       comments-count?: string | number | boolean | null,
>       version-id?: string | number | boolean | null,
>       private?: string | number | boolean | null,
>       status?: string | number | boolean | null,
>       category-id?: string | number | boolean | null,
>       version?: string | number | boolean | null,
>       originalName?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       last-changed-on?: string | number | boolean | null,
>       size?: string | number | boolean | null,
>       versions?: (
>         {
>         } | null
>       )[] | null,
>       thumbURL?: string | number | boolean | null,
>       file-source?: string | number | boolean | null,
>       uploaded-by-user-first-name?: string | number | boolean | null,
>       category-name?: string | number | boolean | null
>     } | null
>   )[] | null,
>   id?: string | number | boolean | null
> } | null
> ```

***

### listForTask

`files.listForTask`

List the files on a task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.files.listForTask({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `project` | `object \| null` | No | — |

> [accordion] project full type
>
> ```ts theme={null}
> {
>   company?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   files?: (
>     {
>       project-id?: string | number | boolean | null,
>       filenameOnDisk?: string | number | boolean | null,
>       can-upload-new-version?: string | number | boolean | null,
>       uploaded-date?: string | number | boolean | null,
>       read-comments-count?: string | number | boolean | null,
>       extraData?: string | number | boolean | null,
>       private?: string | number | boolean | null,
>       version-id?: string | number | boolean | null,
>       userFollowingComments?: string | number | boolean | null,
>       comments-count?: string | number | boolean | null,
>       status?: string | number | boolean | null,
>       changeFollowerIds?: string | number | boolean | null,
>       tags?: (
>         {
>         } | null
>       )[] | null,
>       version?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       last-changed-on?: string | number | boolean | null,
>       commentFollowerIds?: string | number | boolean | null,
>       shareable?: string | number | boolean | null,
>       versions?: (
>         {
>         } | null
>       )[] | null,
>       thumbURL?: string | number | boolean | null,
>       uploaded-by-user-first-name?: string | number | boolean | null,
>       uploaded-by-user-last-name?: string | number | boolean | null,
>       name?: string | number | boolean | null,
>       uploaded-by-userId?: string | number | boolean | null,
>       userFollowingChanges?: string | number | boolean | null,
>       category-id?: string | number | boolean | null,
>       originalName?: string | number | boolean | null,
>       size?: string | number | boolean | null,
>       file-source?: string | number | boolean | null,
>       category-name?: string | number | boolean | null
>     } | null
>   )[] | null,
>   id?: string | number | boolean | null
> } | null
> ```

***

## Link Categories

### create

`linkCategories.create`

Create a link category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.linkCategories.create({
	path: { id: '1470497' },
	body: {
		category: { name: 'Design references' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`linkCategories.delete`

Delete a link category.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.linkCategories.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`linkCategories.get`

Get one link category.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.linkCategories.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `object \| null` | No | — |

> [accordion] category full type
>
> ```ts theme={null}
> {
>   project-id?: string | number | boolean | null,
>   parent-id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   count?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   elements_count?: string | number | boolean | null,
>   type?: string | number | boolean | null
> } | null
> ```

***

### list

`linkCategories.list`

List a project's link categories.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.linkCategories.list({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `categories` | `object[] \| null` | No | — |

> [accordion] categories full type
>
> ```ts theme={null}
> (
>   {
>     project-id?: string | number | boolean | null,
>     parent-id?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     elements_count?: string | number | boolean | null,
>     type?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

## Links

### create

`links.create`

Add a link to a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.links.create({
	path: { id: '1470497' },
	body: {
		link: { name: 'Brand guide', code: 'https://acme.example/brand', notify-current-user: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   link?: {
>     notify?: string,
>     notify-current-user?: boolean,
>     code?: string,
>     category-id?: number,
>     width?: string,
>     height?: string,
>     name?: string,
>     tagIds?: string,
>     grant-access-to?: string,
>     private?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `link` | `object \| null` | No | — |

> [accordion] link full type
>
> ```ts theme={null}
> {
>   notify?: string | number | boolean | null,
>   notify-current-user?: string | number | boolean | null,
>   code?: string | number | boolean | null,
>   category-id?: string | number | boolean | null,
>   width?: string | number | boolean | null,
>   height?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   tagIds?: string | number | boolean | null,
>   grant-access-to?: string | number | boolean | null,
>   private?: string | number | boolean | null
> } | null
> ```

***

### delete

`links.delete`

Delete a link.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.links.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`links.get`

Get one link.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.links.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `link` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] link full type
>
> ```ts theme={null}
> {
>   project-id?: string | number | boolean | null,
>   commentNotifyIds?: string | number | boolean | null,
>   created-by-userfirstname?: string | number | boolean | null,
>   height?: string | number | boolean | null,
>   comments-count?: string | number | boolean | null,
>   private?: string | number | boolean | null,
>   userFollowingComments?: string | number | boolean | null,
>   updated-date?: string | number | boolean | null,
>   changeFollowerIds?: string | number | boolean | null,
>   created-by-userlastname?: string | number | boolean | null,
>   tags?: (
>     {
>     } | null
>   )[] | null,
>   canEdit?: string | number | boolean | null,
>   userDisplayUpdatedTime?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   commentFollowerIds?: string | number | boolean | null,
>   created-date?: string | number | boolean | null,
>   code?: string | number | boolean | null,
>   userDisplayUpdatedDate?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   userFollowingChanges?: string | number | boolean | null,
>   combinedFollowersCount?: string | number | boolean | null,
>   width?: string | number | boolean | null,
>   created-by-userId?: string | number | boolean | null,
>   category-id?: string | number | boolean | null,
>   project-name?: string | number | boolean | null,
>   open-in-new-window?: string | number | boolean | null,
>   provider?: string | number | boolean | null,
>   lockdownId?: string | number | boolean | null,
>   category-name?: string | number | boolean | null
> } | null
> ```

***

### list

`links.list`

List links across all projects.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.links.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `projects` | `object[] \| null` | No | — |

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     links?: (
>       {
>         project-id?: string | number | boolean | null,
>         name?: string | number | boolean | null,
>         created-by-userfirstname?: string | number | boolean | null,
>         height?: string | number | boolean | null,
>         private?: string | number | boolean | null,
>         width?: string | number | boolean | null,
>         created-by-userId?: string | number | boolean | null,
>         created-by-userlastname?: string | number | boolean | null,
>         category-id?: string | number | boolean | null,
>         open-in-new-window?: string | number | boolean | null,
>         id?: string | number | boolean | null,
>         provider?: string | number | boolean | null,
>         created-date?: string | number | boolean | null,
>         category-name?: string | number | boolean | null,
>         code?: string | number | boolean | null
>       } | null
>     )[] | null,
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### listForProject

`links.listForProject`

List the links on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.links.listForProject({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `project` | `object \| null` | No | — |

> [accordion] project full type
>
> ```ts theme={null}
> {
>   links?: (
>     {
>       project-id?: string | number | boolean | null,
>       name?: string | number | boolean | null,
>       created-by-userfirstname?: string | number | boolean | null,
>       height?: string | number | boolean | null,
>       private?: string | number | boolean | null,
>       width?: string | number | boolean | null,
>       created-by-userId?: string | number | boolean | null,
>       created-by-userlastname?: string | number | boolean | null,
>       category-id?: string | number | boolean | null,
>       open-in-new-window?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       provider?: string | number | boolean | null,
>       created-date?: string | number | boolean | null,
>       category-name?: string | number | boolean | null,
>       code?: string | number | boolean | null
>     } | null
>   )[] | null,
>   name?: string | number | boolean | null,
>   id?: string | number | boolean | null
> } | null
> ```

***

### update

`links.update`

Update a link.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.links.update({
	path: { id: '711029' },
	body: {
		link: { name: 'Brand guide v2', code: 'https://acme.example/brand-v2' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   link?: {
>     notify?: string,
>     notify-current-user?: boolean,
>     code?: string,
>     category-id?: number,
>     width?: string,
>     height?: string,
>     name?: string,
>     tagIds?: string,
>     grant-access-to?: string,
>     private?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Milestones

### complete

`milestones.complete`

Mark a milestone complete.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.milestones.complete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### create

`milestones.create`

Create a milestone in a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.milestones.create({
	path: { id: '1470497' },
	body: {
		milestone: {
			title: 'Launch day',
			deadline: '20261130',
			responsible-party-ids: '753865',
			notify: false,
			reminder: false,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   milestone?: {
>     changeFollowerIds?: string,
>     deadline?: string,
>     notify?: boolean,
>     responsible-party-ids?: string,
>     tagIds?: string,
>     reminder?: boolean,
>     taskListIds?: string[],
>     grant-access-to?: string,
>     private?: boolean
>   },
>   move-upcoming-milestones?: boolean,
>   move-upcoming-milestones-off-weekends?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `milestoneid` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`milestones.delete`

Delete a milestone (it goes to the trash).

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.milestones.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`milestones.get`

Get one milestone.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.milestones.get({
	path: { milestoneId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   milestoneId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | calendar | agenda,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   projectStatus?: string,
>   orderMode?: asc | desc,
>   orderBy?: date | dateonly | name | project | user | dateCreated | dateUpdated | id | completion | originalDueDate | dateCompleted | completedBy | status | variance,
>   dueBeforeDate?: string,
>   dueBefore?: string,
>   dueAfterDate?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showPrivate?: boolean,
>   showDeleted?: boolean,
>   showAttachedTasklists?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   progress?: boolean,
>   onlyWithoutTasklists?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyMyProjects?: boolean,
>   onlyAdminProjects?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTags?: boolean,
>   includeProgress?: boolean,
>   includePercentageComplete?: boolean,
>   includeCompleted?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   emoji?: boolean,
>   countUnreadComments?: boolean,
>   calendar?: boolean,
>   tagIds?: number[],
>   status?: (all | new | reopened | completed | deleted | pending | incomplete | late | today | upcoming)[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: string[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: number[],
>   projectHealth?: number[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | users | completedBy | createdBy | deletedBy | updatedBy | commentFollowers | changeFollowers | completeFollowers | tags | tasklists | tasklisttaskstats | teams | companies)[],
>   ids?: number[],
>   followerIds?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   creatorIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `milestone` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklistTaskStats?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] milestone full type
>
> ```ts theme={null}
> {
>   canComplete?: boolean | null,
>   canEdit?: boolean | null,
>   changeFollowerIds?: (number | null)[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   commentFollowerIds?: (number | null)[] | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   commentsCount?: number | null,
>   completed?: boolean | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   completerId?: number | null,
>   createdBy?: number | null,
>   createdOn?: string | null,
>   creatorUserId?: number | null,
>   deadline?: string | null,
>   deletedOn?: string | null,
>   descriptionHTML?: string | null,
>   id?: number | null,
>   isDeleted?: boolean | null,
>   lastChangedOn?: string | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   lockdownId?: number | null,
>   name?: string | null,
>   numCommentsRead?: number | null,
>   originalDueDate?: string | null,
>   percentageComplete?: number | null,
>   percentageTasksCompleted?: number | null,
>   private?: boolean | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   reminder?: boolean | null,
>   responsibleParties?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   responsiblePartyIds?: (number | null)[] | null,
>   status?: string | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklistIds?: (number | null)[] | null,
>   tasklists?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   updatedBy?: number | null,
>   userFollowingChanges?: boolean | null,
>   userFollowingComments?: boolean | null,
>   userFollowingComplete?: boolean | null
> } | null
> ```

***

### list

`milestones.list`

List milestones. Filter with projectIds, assignedToUserIds, tagIds and more.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.milestones.list({
	query: {
		projectIds: [1470497],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | calendar | agenda,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   projectStatus?: string,
>   orderMode?: asc | desc,
>   orderBy?: date | dateonly | name | project | user | dateCreated | dateUpdated | id | completion | originalDueDate | dateCompleted | completedBy | status | variance,
>   dueBeforeDate?: string,
>   dueBefore?: string,
>   dueAfterDate?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showPrivate?: boolean,
>   showDeleted?: boolean,
>   showAttachedTasklists?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   progress?: boolean,
>   onlyWithoutTasklists?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyMyProjects?: boolean,
>   onlyAdminProjects?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTags?: boolean,
>   includeProgress?: boolean,
>   includePercentageComplete?: boolean,
>   includeCompleted?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   emoji?: boolean,
>   countUnreadComments?: boolean,
>   calendar?: boolean,
>   tagIds?: number[],
>   status?: (all | new | reopened | completed | deleted | pending | incomplete | late | today | upcoming)[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: string[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: number[],
>   projectHealth?: number[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | users | completedBy | createdBy | deletedBy | updatedBy | commentFollowers | changeFollowers | completeFollowers | tags | tasklists | tasklisttaskstats | teams | companies)[],
>   ids?: number[],
>   followerIds?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   creatorIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `milestones` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklistTaskStats?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] milestones full type
>
> ```ts theme={null}
> (
>   {
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     changeFollowerIds?: (number | null)[] | null,
>     changeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     commentFollowerIds?: (number | null)[] | null,
>     commentFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     commentsCount?: number | null,
>     completed?: boolean | null,
>     completedBy?: number | null,
>     completedOn?: string | null,
>     completerId?: number | null,
>     createdBy?: number | null,
>     createdOn?: string | null,
>     creatorUserId?: number | null,
>     deadline?: string | null,
>     deletedOn?: string | null,
>     descriptionHTML?: string | null,
>     id?: number | null,
>     isDeleted?: boolean | null,
>     lastChangedOn?: string | null,
>     latestUpdates?: (
>       {
>         after?: any | null,
>         before?: any | null,
>         field?: string | null
>       } | null
>     )[] | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     lockdownId?: number | null,
>     name?: string | null,
>     numCommentsRead?: number | null,
>     originalDueDate?: string | null,
>     percentageComplete?: number | null,
>     percentageTasksCompleted?: number | null,
>     private?: boolean | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     reminder?: boolean | null,
>     responsibleParties?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     responsiblePartyIds?: (number | null)[] | null,
>     status?: string | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasklistIds?: (number | null)[] | null,
>     tasklists?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     updatedBy?: number | null,
>     userFollowingChanges?: boolean | null,
>     userFollowingComments?: boolean | null,
>     userFollowingComplete?: boolean | null
>   } | null
> )[] | null
> ```

***

### listByDeadline

`milestones.listByDeadline`

List milestones due in a date range.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.milestones.listByDeadline({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   startDate: string,
>   endDate: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[] \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> (
>   {
>     date?: string | null,
>     value?: number | null
>   } | null
> )[] | null
> ```

***

### uncomplete

`milestones.uncomplete`

Reopen a completed milestone.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.milestones.uncomplete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`milestones.update`

Update a milestone.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.milestones.update({
	path: { id: '848392' },
	body: {
		milestone: { title: 'Launch day (moved)', notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   milestone?: {
>     changeFollowerIds?: string,
>     deadline?: string,
>     notify?: boolean,
>     responsible-party-ids?: string,
>     tagIds?: string,
>     reminder?: boolean,
>     taskListIds?: string[],
>     grant-access-to?: string,
>     private?: boolean
>   },
>   move-upcoming-milestones?: boolean,
>   move-upcoming-milestones-off-weekends?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Notebook Categories

### create

`notebookCategories.create`

Create a notebook category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebookCategories.create({
	path: { id: '1470497' },
	body: {
		category: { name: 'Meeting notes' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`notebookCategories.delete`

Delete a notebook category.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.notebookCategories.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`notebookCategories.get`

Get one notebook category.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebookCategories.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `object \| null` | No | — |

> [accordion] category full type
>
> ```ts theme={null}
> {
>   project-id?: string | number | boolean | null,
>   parent-id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   count?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   elements_count?: string | number | boolean | null,
>   type?: string | number | boolean | null
> } | null
> ```

***

### list

`notebookCategories.list`

List a project's notebook categories.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebookCategories.list({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `categories` | `object[] \| null` | No | — |

> [accordion] categories full type
>
> ```ts theme={null}
> (
>   {
>     project-id?: string | number | boolean | null,
>     parent-id?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     elements_count?: string | number | boolean | null,
>     type?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### update

`notebookCategories.update`

Update a notebook category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebookCategories.update({
	path: { id: '1' },
	body: {
		category: { name: 'Kickoff notes' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Notebooks

### copy

`notebooks.copy`

Copy a notebook to another project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.copy({
	path: { id: '423373' },
	body: { projectId: 1470498 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   projectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### create

`notebooks.create`

Create a notebook in a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.create({
	path: { projectId: 1470497 },
	body: {
		notebook: { name: 'Launch notes', contents: 'Decisions from the kickoff' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   getEmoji?: boolean,
>   include?: (projects | projects.permissions | projects.integrations | tags | users | users.teams | notebookCategories | companies | teams)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     notebookCategories
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   notebook?: {
>     categoryId?: number,
>     contents?: string,
>     isFullWidth?: boolean,
>     isPrivate?: boolean,
>     locked?: boolean,
>     name?: string,
>     newVersion?: boolean,
>     notify?: {
>       ids?: {
>         companyIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         jobRoleIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         teamIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         userIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         }
>       },
>       type?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       }
>     },
>     notifyCurrentUser?: boolean,
>     privacy?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       }
>     },
>     secureContent?: boolean,
>     sendDiff?: boolean,
>     tagIds?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: number[]
>     },
>     type?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `notebook` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   notebookCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] notebook full type
>
> ```ts theme={null}
> {
>   category?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   categoryId?: number | null,
>   changeFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentsCount?: number | null,
>   contentHTML?: string | null,
>   contents?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserID?: number | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateUpdated?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserID?: number | null,
>   id?: number | null,
>   isFullWidth?: boolean | null,
>   isPrivate?: boolean | null,
>   latestVersionNo?: number | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   lockdownId?: number | null,
>   locked?: boolean | null,
>   lockedAt?: string | null,
>   lockedBy?: number | null,
>   name?: string | null,
>   notebookVersion?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   notebookVersionCreatedDateTime?: string | null,
>   notebookVersionID?: number | null,
>   notebookVersionUpdatedDateTime?: string | null,
>   privacy?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   readCommentsCount?: number | null,
>   secureContent?: boolean | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   updatedByUserID?: number | null,
>   userFollowingChanges?: boolean | null,
>   userFollowingComments?: boolean | null,
>   versionCount?: number | null
> } | null
> ```

***

### delete

`notebooks.delete`

Delete a notebook.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.notebooks.delete({
	path: { notebookId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### deleteVersions

`notebooks.deleteVersions`

Delete notebook versions.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.notebooks.deleteVersions({
	path: { notebookId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   versionIds?: number[]
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### get

`notebooks.get`

Get one notebook with its contents.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebooks.get({
	path: { notebookId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   showDeleted?: boolean,
>   getEmoji?: boolean,
>   include?: (projects | projects.permissions | projects.integrations | tags | users | users.teams | notebookCategories | companies | teams)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     notebookCategories
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `notebook` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   notebookCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] notebook full type
>
> ```ts theme={null}
> {
>   category?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   categoryId?: number | null,
>   changeFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentsCount?: number | null,
>   contentHTML?: string | null,
>   contents?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserID?: number | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateUpdated?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserID?: number | null,
>   id?: number | null,
>   isFullWidth?: boolean | null,
>   isPrivate?: boolean | null,
>   latestVersionNo?: number | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   lockdownId?: number | null,
>   locked?: boolean | null,
>   lockedAt?: string | null,
>   lockedBy?: number | null,
>   name?: string | null,
>   notebookVersion?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   notebookVersionCreatedDateTime?: string | null,
>   notebookVersionID?: number | null,
>   notebookVersionUpdatedDateTime?: string | null,
>   privacy?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   readCommentsCount?: number | null,
>   secureContent?: boolean | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   updatedByUserID?: number | null,
>   userFollowingChanges?: boolean | null,
>   userFollowingComments?: boolean | null,
>   versionCount?: number | null
> } | null
> ```

***

### getVersion

`notebooks.getVersion`

Get one version of a notebook.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebooks.getVersion({
	path: { versionId: 1, notebookId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   versionId: number,
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: users[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `version` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   users?: {
>   } | null
> } | null
> ```

> [accordion] version full type
>
> ```ts theme={null}
> {
>   contentHTML?: string | null,
>   contents?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserID?: number | null,
>   dateCreated?: string | null,
>   dateUpdated?: string | null,
>   notebook?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   notebookId?: number | null,
>   updatedAt?: string | null,
>   versionId?: number | null,
>   versionNumber?: number | null
> } | null
> ```

***

### list

`notebooks.list`

List notebooks. Filter with projectIds, categoryIds, tagIds.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebooks.list({
	query: {
		projectIds: [1470497],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   searchTerm?: string,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   projectStatuses?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | project | dateCreated | dateUpdated | category | id,
>   createdAfterDate?: string,
>   createdAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   secureOnly?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   lockedOnly?: boolean,
>   includeContents?: boolean,
>   includeArchivedProjects?: boolean,
>   getEmoji?: boolean,
>   tagIds?: number[],
>   projectTagIds?: number[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.permissions | projects.integrations | tags | users | users.teams | notebookCategories | companies | teams)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     notebookCategories
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   creatorIds?: number[],
>   categoryIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `notebooks` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   notebookCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] notebooks full type
>
> ```ts theme={null}
> (
>   {
>     category?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     categoryId?: number | null,
>     changeFollowers?: {
>       companies?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       companyIds?: (number | null)[] | null,
>       teamIds?: (number | null)[] | null,
>       teams?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       userIds?: (number | null)[] | null,
>       users?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null
>     } | null,
>     commentFollowers?: {
>       companies?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       companyIds?: (number | null)[] | null,
>       teamIds?: (number | null)[] | null,
>       teams?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       userIds?: (number | null)[] | null,
>       users?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null
>     } | null,
>     commentsCount?: number | null,
>     contentHTML?: string | null,
>     contents?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserID?: number | null,
>     dateCreated?: string | null,
>     dateDeleted?: string | null,
>     dateUpdated?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     deletedByUserID?: number | null,
>     id?: number | null,
>     isFullWidth?: boolean | null,
>     isPrivate?: boolean | null,
>     latestVersionNo?: number | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     lockdownId?: number | null,
>     locked?: boolean | null,
>     lockedAt?: string | null,
>     lockedBy?: number | null,
>     name?: string | null,
>     notebookVersion?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     notebookVersionCreatedDateTime?: string | null,
>     notebookVersionID?: number | null,
>     notebookVersionUpdatedDateTime?: string | null,
>     privacy?: {
>       companies?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       companyIds?: (number | null)[] | null,
>       teamIds?: (number | null)[] | null,
>       teams?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       userIds?: (number | null)[] | null,
>       users?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null
>     } | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     readCommentsCount?: number | null,
>     secureContent?: boolean | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     type?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     updatedByUserID?: number | null,
>     userFollowingChanges?: boolean | null,
>     userFollowingComments?: boolean | null,
>     versionCount?: number | null
>   } | null
> )[] | null
> ```

***

### listVersions

`notebooks.listVersions`

List a notebook's versions.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.notebooks.listVersions({
	path: { notebookId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: users[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `versions` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   users?: {
>   } | null
> } | null
> ```

> [accordion] versions full type
>
> ```ts theme={null}
> (
>   {
>     contentHTML?: string | null,
>     contents?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserID?: number | null,
>     dateCreated?: string | null,
>     dateUpdated?: string | null,
>     notebook?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     notebookId?: number | null,
>     updatedAt?: string | null,
>     versionId?: number | null,
>     versionNumber?: number | null
>   } | null
> )[] | null
> ```

***

### lock

`notebooks.lock`

Lock a notebook for editing.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.lock({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### move

`notebooks.move`

Move a notebook to another project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.move({
	path: { id: '423373' },
	body: { projectId: 1470498 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   projectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### unlock

`notebooks.unlock`

Unlock a notebook.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.unlock({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`notebooks.update`

Update a notebook.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.notebooks.update({
	path: { notebookId: 423373 },
	body: {
		notebook: { contents: 'Decisions from the kickoff, updated', newVersion: true },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   notebookId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   getEmoji?: boolean,
>   include?: (projects | projects.permissions | projects.integrations | tags | users | users.teams | notebookCategories | companies | teams)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     notebooks
>   ]?: (id | name | description | contents | type | isPrivate | locked | lockdownId | secureContent | projectId | createdByUserID | updatedByUserID | deletedByUserID | dateUpdated | dateCreated | dateDeleted | deleted | categoryId | notebookVersionID | notebookVersionCreatedDateTime | notebookVersionUpdatedDateTime | latestVersionNo | commentsCount | readCommentsCount | contentHTML | privacy | commentFollowers | changeFollowers | tagIds | updatedAt | project)[],
>   fields[
>     notebookCategories
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[]
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   notebook?: {
>     categoryId?: number,
>     contents?: string,
>     isFullWidth?: boolean,
>     isPrivate?: boolean,
>     locked?: boolean,
>     name?: string,
>     newVersion?: boolean,
>     notify?: {
>       ids?: {
>         companyIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         jobRoleIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         teamIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         },
>         userIds?: {
>           Null?: boolean,
>           Set?: boolean,
>           Value?: number[]
>         }
>       },
>       type?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       }
>     },
>     notifyCurrentUser?: boolean,
>     privacy?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       },
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       }
>     },
>     secureContent?: boolean,
>     sendDiff?: boolean,
>     tagIds?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: number[]
>     },
>     type?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `notebook` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   notebookCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] notebook full type
>
> ```ts theme={null}
> {
>   category?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   categoryId?: number | null,
>   changeFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentFollowers?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   commentsCount?: number | null,
>   contentHTML?: string | null,
>   contents?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserID?: number | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateUpdated?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserID?: number | null,
>   id?: number | null,
>   isFullWidth?: boolean | null,
>   isPrivate?: boolean | null,
>   latestVersionNo?: number | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   lockdownId?: number | null,
>   locked?: boolean | null,
>   lockedAt?: string | null,
>   lockedBy?: number | null,
>   name?: string | null,
>   notebookVersion?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   notebookVersionCreatedDateTime?: string | null,
>   notebookVersionID?: number | null,
>   notebookVersionUpdatedDateTime?: string | null,
>   privacy?: {
>     companies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     companyIds?: (number | null)[] | null,
>     teamIds?: (number | null)[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     userIds?: (number | null)[] | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   readCommentsCount?: number | null,
>   secureContent?: boolean | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   updatedByUserID?: number | null,
>   userFollowingChanges?: boolean | null,
>   userFollowingComments?: boolean | null,
>   versionCount?: number | null
> } | null
> ```

***

## People

### addToProjects

`people.addToProjects`

Add one user to many projects at once.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.people.addToProjects({
	path: { userId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   userId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `info` | `(string \| null)[] \| null` | No | — |
| `teamIds` | `(number \| null)[] \| null` | No | — |
| `usersAdded` | `(number \| null)[] \| null` | No | — |
| `usersAlreadyInProject` | `(number \| null)[] \| null` | No | — |
| `usersNotAdded` | `(number \| null)[] \| null` | No | — |

***

### create

`people.create`

Add a user to the site. Teamwork emails them an invitation unless sendInvite is false.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.people.create({
	body: {
		person: {
			email-address: 'sam@acme.example',
			first-name: 'Sam',
			last-name: 'Lee',
			sendInvite: false,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   person?: {
>     startPage?: string,
>     email-address?: string,
>     first-name?: string,
>     last-name?: string,
>     company-id?: number,
>     sendInvite?: boolean,
>     phone-number-office?: string,
>     phone-number-office-ext?: string,
>     phone-number-mobile-countrycode?: string,
>     phone-number-mobile-prefix?: string,
>     phone-number-mobile?: string,
>     phone-number-home?: string,
>     phone-number-fax?: string,
>     email-alt-1?: string,
>     email-alt-2?: string,
>     email-alt-3?: string,
>     address?: {
>       line1?: string,
>       line2?: string,
>       city?: string,
>       state?: string,
>       zipcode?: string,
>       countrycode?: string
>     },
>     profile?: string,
>     userTwitterName?: string,
>     userLinkedin?: string,
>     userFacebook?: string,
>     userWebsite?: string,
>     im-service?: string,
>     im-handle?: string,
>     language?: string,
>     dateFormatId?: number,
>     timeFormatId?: number,
>     timezoneId?: number,
>     calendarStartsOnSunday?: string,
>     lengthOfDay?: number,
>     workingHours?: {
>       entries?: {
>         weekday?: string,
>         taskHours?: number
>       }[]
>     },
>     changeForEveryone?: boolean,
>     administrator?: boolean,
>     canAddProjects?: boolean,
>     canManagePeople?: boolean,
>     autoGiveProjectAccess?: boolean,
>     canAccessCalendar?: boolean,
>     canAccessTemplates?: boolean,
>     canAccessPortfolio?: boolean,
>     canManageCustomFields?: boolean,
>     canManagePortfolio?: boolean,
>     canManageProjectTemplates?: boolean,
>     canViewProjectTemplates?: boolean,
>     notifyOnTaskComplete?: boolean,
>     notify-on-added-as-follower?: boolean,
>     notify-on-status-update?: boolean,
>     textFormat?: string,
>     useShorthandDurations?: boolean,
>     userReceiveNotifyWarnings?: boolean,
>     userReceiveMyNotificationsOnly?: boolean,
>     receiveDailyReports?: boolean,
>     receiveDailyReportsAtWeekend?: boolean,
>     receiveDailyReportsIfEmpty?: boolean,
>     soundAlertsEnabled?: boolean,
>     dailyReportSort?: string,
>     receiveDailyReportsAtTime?: string,
>     dailyReportEventsType?: string,
>     dailyReportDaysFilter?: number,
>     avatarPendingFileRef?: string,
>     removeAvatar?: boolean,
>     allowEmailNotifications?: boolean,
>     user-type?: string,
>     privateNotes?: string,
>     getUserDetails?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `user` | `object \| null` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   avatarUrl?: string | number | boolean | null,
>   firstName?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   lastName?: string | number | boolean | null
> } | null
> ```

***

### delete

`people.delete`

Delete a user.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.people.delete({
	path: { personId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   personId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### get

`people.get`

Get one person.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.get({
	path: { personId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   personId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userType?: account | collaborator | contact | client,
>   updatedAfter?: string,
>   searchTerm?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | namecaseinsensitive | company | id | providedids | dateupdated,
>   lastLoginAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   searchUserSkill?: boolean,
>   searchUserJobRole?: boolean,
>   orderPrioritiseCurrentUser?: boolean,
>   onlySiteOwner?: boolean,
>   onlyPlaceholders?: boolean,
>   onlyOwnerCompany?: boolean,
>   inclusiveFilter?: boolean,
>   includeStandardUsers?: boolean,
>   includeServiceAccounts?: boolean,
>   includePlaceholders?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   filterByNoCostRate?: boolean,
>   excludeContacts?: boolean,
>   clientPortalEligible?: boolean,
>   adminsOnly?: boolean,
>   teamIds?: number[],
>   skillIds?: number[],
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   notLinkedWithClientPortalIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | workingHours | currencies | teams | jobRoles | skills | linkedClientPortalCompanies | skillCounts)[],
>   ids?: number[],
>   fields[
>     userIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     people
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeProjectIds?: number[],
>   excludeIds?: number[],
>   excludeAllocatedUsersProjectIDs?: number[],
>   emails?: string[],
>   companyIds?: number[],
>   SkillLevels?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `person` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   linkedClientPortalCompanies?: {
>   } | null,
>   skills?: {
>   } | null,
>   teams?: {
>   } | null,
>   userIntegrations?: {
>   } | null,
>   workingHours?: {
>   } | null
> } | null
> ```

> [accordion] person full type
>
> ```ts theme={null}
> {
>   avatarUrl?: string | null,
>   canAccessPortfolio?: boolean | null,
>   canAddProjects?: boolean | null,
>   canManagePortfolio?: boolean | null,
>   company?: {
>     id?: number | null,
>     meta?: {
>       name?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   companyId?: number | null,
>   companyRoleId?: number | null,
>   createdAt?: string | null,
>   createdBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   deleted?: boolean | null,
>   email?: string | null,
>   firstName?: string | null,
>   id?: number | null,
>   inOwnerCompany?: boolean | null,
>   isAdmin?: boolean | null,
>   isClientUser?: boolean | null,
>   isPlaceholderResource?: boolean | null,
>   isServiceAccount?: boolean | null,
>   jobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   lastLogin?: string | null,
>   lastName?: string | null,
>   lengthOfDay?: number | null,
>   linkedClientPortalCompany?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   linkedClientPortalCompanyId?: number | null,
>   loginTarget?: string | null,
>   meta?: {
>   } | null,
>   siteOwner?: boolean | null,
>   skills?: (
>     {
>       id?: number | null,
>       meta?: {
>         level?: number | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   teams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timezone?: string | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userCost?: number | null,
>   userRate?: number | null,
>   userRates?: {
>   } | null,
>   workingHour?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   workingHoursId?: number | null
> } | null
> ```

***

### list

`people.list`

List people. Filter with projectIds, companyIds, teamIds, searchTerm and more.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.list({
	query: {
		projectIds: [1470497],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userType?: account | collaborator | contact | client,
>   updatedAfter?: string,
>   searchTerm?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | namecaseinsensitive | company | id | providedids | dateupdated,
>   lastLoginAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   searchUserSkill?: boolean,
>   searchUserJobRole?: boolean,
>   orderPrioritiseCurrentUser?: boolean,
>   onlySiteOwner?: boolean,
>   onlyPlaceholders?: boolean,
>   onlyOwnerCompany?: boolean,
>   inclusiveFilter?: boolean,
>   includeStandardUsers?: boolean,
>   includeServiceAccounts?: boolean,
>   includePlaceholders?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   filterByNoCostRate?: boolean,
>   excludeContacts?: boolean,
>   clientPortalEligible?: boolean,
>   adminsOnly?: boolean,
>   teamIds?: number[],
>   skillIds?: number[],
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   notLinkedWithClientPortalIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | workingHours | currencies | teams | jobRoles | skills | linkedClientPortalCompanies | skillCounts)[],
>   ids?: number[],
>   fields[
>     userIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     people
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeProjectIds?: number[],
>   excludeIds?: number[],
>   excludeAllocatedUsersProjectIDs?: number[],
>   emails?: string[],
>   companyIds?: number[],
>   SkillLevels?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `failed` | `object[] \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `people` | `object[] \| null` | No | — |

> [accordion] failed full type
>
> ```ts theme={null}
> (
>   {
>     errors?: (
>       {
>         code?: string | null,
>         detail?: string | null,
>         id?: string | null,
>         meta?: {
>         } | null
>       } | null
>     )[] | null,
>     index?: number | null
>   } | null
> )[] | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   linkedClientPortalCompanies?: {
>   } | null,
>   skills?: {
>   } | null,
>   teams?: {
>   } | null,
>   userIntegrations?: {
>   } | null,
>   workingHours?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   skillCounts?: {
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] people full type
>
> ```ts theme={null}
> (
>   {
>     avatarUrl?: string | null,
>     canAccessPortfolio?: boolean | null,
>     canAddProjects?: boolean | null,
>     canManagePortfolio?: boolean | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     companyRoleId?: number | null,
>     createdAt?: string | null,
>     createdBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     deleted?: boolean | null,
>     email?: string | null,
>     firstName?: string | null,
>     id?: number | null,
>     inOwnerCompany?: boolean | null,
>     isAdmin?: boolean | null,
>     isClientUser?: boolean | null,
>     isPlaceholderResource?: boolean | null,
>     isServiceAccount?: boolean | null,
>     jobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     lastLogin?: string | null,
>     lastName?: string | null,
>     lengthOfDay?: number | null,
>     linkedClientPortalCompany?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     linkedClientPortalCompanyId?: number | null,
>     loginTarget?: string | null,
>     meta?: {
>     } | null,
>     siteOwner?: boolean | null,
>     skills?: (
>       {
>         id?: number | null,
>         meta?: {
>           level?: number | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     timezone?: string | null,
>     type?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userCost?: number | null,
>     userRate?: number | null,
>     userRates?: {
>     } | null,
>     workingHour?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     workingHoursId?: number | null
>   } | null
> )[] | null
> ```

***

### listDeleted

`people.listDeleted`

List deleted users.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.listDeleted({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   groupByCompany?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `people` | `object[] \| null` | No | — |

> [accordion] people full type
>
> ```ts theme={null}
> (
>   {
>     avatarUrl?: string | number | boolean | null,
>     deletedByUserFirstName?: string | number | boolean | null,
>     companyName?: string | number | boolean | null,
>     deletedByUserId?: string | number | boolean | null,
>     deletedByUserLastName?: string | number | boolean | null,
>     isInOwnerCompany?: string | number | boolean | null,
>     firstName?: string | number | boolean | null,
>     userType?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     deletedDateTime?: string | number | boolean | null,
>     emailAddress?: string | number | boolean | null,
>     companyId?: string | number | boolean | null,
>     lastName?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### me

`people.me`

Get the user the API key belongs to.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.me({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userId?: number,
>   includeAuth?: boolean,
>   include?: (projects | users)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `person` | `object \| null` | No | — |

> [accordion] person full type
>
> ```ts theme={null}
> {
>   administrator?: boolean | null,
>   auth?: {
>     timestamp?: string | null,
>     token?: string | null,
>     userType?: string | null
>   } | null,
>   avatarUrl?: string | null,
>   canAccessPortfolio?: boolean | null,
>   canAddProjects?: boolean | null,
>   canManagePortfolio?: boolean | null,
>   canShareAISkills?: boolean | null,
>   company?: {
>     id?: number | null,
>     meta?: {
>       name?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   companyId?: number | null,
>   companyRoleId?: number | null,
>   createdAt?: string | null,
>   createdBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   deleted?: boolean | null,
>   email?: string | null,
>   emailAddress?: string | null,
>   firstName?: string | null,
>   id?: number | null,
>   inOwnerCompany?: boolean | null,
>   installationId?: number | null,
>   isAdmin?: boolean | null,
>   isClientUser?: boolean | null,
>   isPlaceholderResource?: boolean | null,
>   isServiceAccount?: boolean | null,
>   jobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   lastLogin?: string | null,
>   lastName?: string | null,
>   ldHash?: string | null,
>   lengthOfDay?: number | null,
>   linkedClientPortalCompany?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   linkedClientPortalCompanyId?: number | null,
>   loginTarget?: string | null,
>   meta?: {
>   } | null,
>   phoneNumberMobile?: string | null,
>   siteOwner?: boolean | null,
>   skills?: (
>     {
>       id?: number | null,
>       meta?: {
>         level?: number | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   teams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timezone?: string | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userCost?: number | null,
>   userName?: string | null,
>   userRate?: number | null,
>   userRates?: {
>   } | null,
>   userType?: string | null,
>   workingHour?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   workingHoursId?: number | null
> } | null
> ```

***

### myStats

`people.myStats`

Summary counts for the current user (tasks, milestones, messages).

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.myStats({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `stats` | `object \| null` | No | — |

> [accordion] stats full type
>
> ```ts theme={null}
> {
>   tasks?: {
>     today?: string | number | boolean | null,
>     late?: string | number | boolean | null,
>     upcoming?: string | number | boolean | null
>   } | null,
>   permissions?: {
>     canLogTime?: string | number | boolean | null,
>     canAddMilestones?: string | number | boolean | null,
>     canAddTasks?: string | number | boolean | null,
>     canAddMessages?: string | number | boolean | null
>   } | null,
>   events?: {
>     count?: string | number | boolean | null,
>     hasEvents?: string | number | boolean | null
>   } | null,
>   milestones?: {
>     today?: string | number | boolean | null,
>     late?: string | number | boolean | null,
>     complete?: string | number | boolean | null,
>     upcoming?: string | number | boolean | null,
>     active?: string | number | boolean | null
>   } | null,
>   projects?: {
>     starred?: string | number | boolean | null,
>     late?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     archived?: string | number | boolean | null,
>     upcoming?: string | number | boolean | null,
>     completed?: string | number | boolean | null,
>     current?: string | number | boolean | null
>   } | null
> } | null
> ```

***

### performance

`people.performance`

The users who completed the most tasks.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.performance({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   startDate: string,
>   orderMode?: asc | desc,
>   endDate: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[] \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> (
>   {
>     name?: string | null,
>     value?: number | null
>   } | null
> )[] | null
> ```

***

### taskCompletion

`people.taskCompletion`

Task completions per user.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.taskCompletion({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userType?: account | collaborator | contact | client,
>   updatedAfter?: string,
>   startDate: string,
>   searchTerm?: string,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: id | name | namecaseinsensitive | overduetasks | assignedtasks | completedtasks | projects | activeprojects,
>   lastLoginAfter?: string,
>   endDate: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   searchUserSkill?: boolean,
>   searchUserJobRole?: boolean,
>   orderPrioritiseCurrentUser?: boolean,
>   onlySiteOwner?: boolean,
>   onlyPlaceholders?: boolean,
>   onlyOwnerCompany?: boolean,
>   isReportDownload?: boolean,
>   inclusiveFilter?: boolean,
>   includeServiceAccounts?: boolean,
>   includePlaceholders?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   includeArchivedProjects?: boolean,
>   filterByNoCostRate?: boolean,
>   excludeContacts?: boolean,
>   clientPortalEligible?: boolean,
>   adminsOnly?: boolean,
>   userProjectIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   notLinkedWithClientPortalIds?: number[],
>   jobRoleIds?: number[],
>   include?: users[],
>   ids?: number[],
>   fields[
>     userIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     people
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeProjectIds?: number[],
>   excludeIds?: number[],
>   excludeAllocatedUsersProjectIDs?: number[],
>   emails?: string[],
>   companyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `taskCompletions` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] taskCompletions full type
>
> ```ts theme={null}
> {
>   totalActiveProjects?: number | null,
>   totalAssignedTasks?: number | null,
>   totalCompletedTasks?: number | null,
>   totalOverdueTasks?: number | null,
>   totalProjects?: number | null,
>   users?: (
>     {
>       activeProjects?: number | null,
>       assignedTasks?: number | null,
>       completedTasks?: number | null,
>       overdueTasks?: number | null,
>       projects?: number | null,
>       userId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### update

`people.update`

Update a user.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.people.update({
	path: { id: '753865' },
	body: {
		person: { first-name: 'Sam', last-name: 'Lee' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   person?: {
>     startPage?: string,
>     email-address?: string,
>     first-name?: string,
>     last-name?: string,
>     company-id?: number,
>     sendInvite?: boolean,
>     phone-number-office?: string,
>     phone-number-office-ext?: string,
>     phone-number-mobile-countrycode?: string,
>     phone-number-mobile-prefix?: string,
>     phone-number-mobile?: string,
>     phone-number-home?: string,
>     phone-number-fax?: string,
>     email-alt-1?: string,
>     email-alt-2?: string,
>     email-alt-3?: string,
>     address?: {
>       line1?: string,
>       line2?: string,
>       city?: string,
>       state?: string,
>       zipcode?: string,
>       countrycode?: string
>     },
>     profile?: string,
>     userTwitterName?: string,
>     userLinkedin?: string,
>     userFacebook?: string,
>     userWebsite?: string,
>     im-service?: string,
>     im-handle?: string,
>     language?: string,
>     dateFormatId?: number,
>     timeFormatId?: number,
>     timezoneId?: number,
>     calendarStartsOnSunday?: string,
>     lengthOfDay?: number,
>     workingHours?: {
>       entries?: {
>         weekday?: string,
>         taskHours?: number
>       }[]
>     },
>     changeForEveryone?: boolean,
>     administrator?: boolean,
>     canAddProjects?: boolean,
>     canManagePeople?: boolean,
>     autoGiveProjectAccess?: boolean,
>     canAccessCalendar?: boolean,
>     canAccessTemplates?: boolean,
>     canAccessPortfolio?: boolean,
>     canManageCustomFields?: boolean,
>     canManagePortfolio?: boolean,
>     canManageProjectTemplates?: boolean,
>     canViewProjectTemplates?: boolean,
>     notifyOnTaskComplete?: boolean,
>     notify-on-added-as-follower?: boolean,
>     notify-on-status-update?: boolean,
>     textFormat?: string,
>     useShorthandDurations?: boolean,
>     userReceiveNotifyWarnings?: boolean,
>     userReceiveMyNotificationsOnly?: boolean,
>     receiveDailyReports?: boolean,
>     receiveDailyReportsAtWeekend?: boolean,
>     receiveDailyReportsIfEmpty?: boolean,
>     soundAlertsEnabled?: boolean,
>     dailyReportSort?: string,
>     receiveDailyReportsAtTime?: string,
>     dailyReportEventsType?: string,
>     dailyReportDaysFilter?: number,
>     avatarPendingFileRef?: string,
>     removeAvatar?: boolean,
>     allowEmailNotifications?: boolean,
>     user-type?: string,
>     privateNotes?: string,
>     getUserDetails?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### utilization

`people.utilization`

User utilization for a date range.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.people.utilization({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   zoom?: week | month | last3months | quarterbyweek | quarterbymonth,
>   startDate: string,
>   sortOrder?: asc | desc,
>   sort?: name | percentutilization | percentestimatedutilization | availableminutes | unavailableminutes | loggedminutes | billableminutes | unbillableminutes | billableutilization | nonbillableutilization | companycount | utilizationachieved | utilizationtarget | allocatedutilization | totalworkingminutes | availableutilization | unavailableutilization | companyname | allocatedminutes | estimatedbillableminutes | percentestimatedbillableutilization | estimatedminutes,
>   searchTerm?: string,
>   reportFormat?: pdf | html | csv | xls | xlsx | google-sheets,
>   orderMode?: asc | desc,
>   orderBy?: name | percentutilization | percentestimatedutilization | availableminutes | unavailableminutes | loggedminutes | billableminutes | unbillableminutes | companycount | utilizationachieved | utilizationTarget | allocatedutilization | totalworkingminutes | availableutilization | unavailableutilization | billableUtilization | nonBillableUtilization | companyname | allocatedMinutes | estimatedbillableminutes | percentEstimatedBillableUtilization | estimatedMinutes,
>   groupBy?: "" | day | week | month | quarter,
>   endDate: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   legacyResponse?: boolean,
>   isReportDownload?: boolean,
>   isCustomDateRange?: boolean,
>   includeUtilizations?: boolean,
>   includeTotals?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   includeCalendarEvents?: boolean,
>   includeArchivedProjects?: boolean,
>   IncludeCompletedTasks?: boolean,
>   userTypes?: (standard | placeholder)[],
>   userIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectIds?: number[],
>   jobRoleIds?: number[],
>   include?: (users | jobroles | teams)[],
>   fields[
>     utilizations
>   ]?: (userId | unavailableMinutes | availableMinutes | billableMinutes | unbillableMinutes | loggedMinutes)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   companyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `dashboardData` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `utilization` | `object \| null \| object[]` | No | — |

> [accordion] dashboardData full type
>
> ```ts theme={null}
> {
>   jobRolesDashboard?: (
>     {
>       data?: {
>         availableMinutes?: number | null,
>         billableUtilization?: number | null,
>         estimatedBillableUtilization?: number | null,
>         estimatedUtilization?: number | null,
>         totalWorkingMinutes?: number | null,
>         unavailableMinutes?: number | null
>       } | null,
>       jobRole?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       jobRoleId?: number | null,
>       users?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null
>     } | null
>   )[] | null,
>   teamsDashboard?: (
>     {
>       data?: {
>         availableMinutes?: number | null,
>         billableUtilization?: number | null,
>         estimatedBillableUtilization?: number | null,
>         estimatedUtilization?: number | null,
>         totalWorkingMinutes?: number | null,
>         unavailableMinutes?: number | null
>       } | null,
>       team?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       teamId?: number | null,
>       users?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null
>     } | null
>   )[] | null,
>   usersDashboard?: (
>     {
>       data?: {
>         availableMinutes?: number | null,
>         billableUtilization?: number | null,
>         estimatedBillableUtilization?: number | null,
>         estimatedUtilization?: number | null,
>         totalWorkingMinutes?: number | null,
>         unavailableMinutes?: number | null
>       } | null,
>       jobRoles?: (
>         {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       )[] | null,
>       user?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       userId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   jobRoles?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] utilization full type
>
> ```ts theme={null}
> {
>   actualUtilization?: number | null,
>   allocatedMinutes?: number | null,
>   allocatedMinutesAverage?: number | null,
>   allocatedUtilization?: number | null,
>   availableMinutes?: number | null,
>   availableMinutesAverage?: number | null,
>   availableUtilization?: number | null,
>   averageCompanyCount?: number | null,
>   averageUtilizationAchieved?: number | null,
>   averageUtilizationTargets?: number | null,
>   billableMinutes?: number | null,
>   billableMinutesAverage?: number | null,
>   billableUtilization?: number | null,
>   endDate?: string | null,
>   estimatedBillableUtilization?: number | null,
>   estimatedMinutes?: number | null,
>   estimatedMinutesAverage?: number | null,
>   estimatedNonBillableUtilization?: number | null,
>   estimatedUtilization?: number | null,
>   loggedMinutes?: number | null,
>   loggedMinutesAverage?: number | null,
>   nonBillableUtilization?: number | null,
>   periodTotals?: (
>     {
>       actualUtilization?: number | null,
>       allocatedMinutes?: number | null,
>       allocatedMinutesAverage?: number | null,
>       allocatedUtilization?: number | null,
>       availableMinutes?: number | null,
>       availableMinutesAverage?: number | null,
>       availableUtilization?: number | null,
>       averageCompanyCount?: number | null,
>       averageUtilizationAchieved?: number | null,
>       averageUtilizationTargets?: number | null,
>       billableMinutes?: number | null,
>       billableMinutesAverage?: number | null,
>       billableUtilization?: number | null,
>       endDate?: string | null,
>       estimatedBillableUtilization?: number | null,
>       estimatedMinutes?: number | null,
>       estimatedMinutesAverage?: number | null,
>       estimatedNonBillableUtilization?: number | null,
>       estimatedUtilization?: number | null,
>       loggedMinutes?: number | null,
>       loggedMinutesAverage?: number | null,
>       nonBillableUtilization?: number | null,
>       rowsCount?: number | null,
>       startDate?: string | null,
>       totalWorkingMinutes?: number | null,
>       totalWorkingMinutesAverage?: number | null,
>       unavailableMinutes?: number | null,
>       unavailableMinutesAverage?: number | null,
>       unavailableUtilization?: number | null,
>       unbillableMinutes?: number | null,
>       unbillableMinutesAverage?: number | null,
>       uniqueCompanyCount?: number | null,
>       usersInTarget?: number | null
>     } | null
>   )[] | null,
>   rowsCount?: number | null,
>   startDate?: string | null,
>   totalWorkingMinutes?: number | null,
>   totalWorkingMinutesAverage?: number | null,
>   unavailableMinutes?: number | null,
>   unavailableMinutesAverage?: number | null,
>   unavailableUtilization?: number | null,
>   unbillableMinutes?: number | null,
>   unbillableMinutesAverage?: number | null,
>   uniqueCompanyCount?: number | null,
>   users?: (
>     {
>       data?: (
>         {
>           actualUtilization?: number | null,
>           allocatedMinutes?: number | null,
>           allocatedUtilization?: number | null,
>           availableMinutes?: number | null,
>           availableUtilization?: number | null,
>           billableMinutes?: number | null,
>           billableUtilization?: number | null,
>           companyCount?: number | null,
>           endDate?: string | null,
>           estimatedBillableUtilization?: number | null,
>           estimatedMinutes?: number | null,
>           estimatedUtilization?: number | null,
>           loggedMinutes?: number | null,
>           nonBillableUtilization?: number | null,
>           startDate?: string | null,
>           totalWorkingMinutes?: number | null,
>           unavailableMinutes?: number | null,
>           unavailableUtilization?: number | null,
>           unbillableMinutes?: number | null,
>           utilizationAchieved?: number | null,
>           utilizationTarget?: number | null,
>           utilizationTargetMinutes?: number | null
>         } | null
>       )[] | null,
>       user?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       userId?: number | null
>     } | null
>   )[] | null,
>   usersInTarget?: number | null
> } | null | (
>   {
>     data?: (
>       {
>         actualUtilization?: number | null,
>         allocatedMinutes?: number | null,
>         allocatedUtilization?: number | null,
>         availableMinutes?: number | null,
>         availableUtilization?: number | null,
>         billableMinutes?: number | null,
>         billableUtilization?: number | null,
>         companyCount?: number | null,
>         endDate?: string | null,
>         estimatedBillableUtilization?: number | null,
>         estimatedMinutes?: number | null,
>         estimatedUtilization?: number | null,
>         loggedMinutes?: number | null,
>         nonBillableUtilization?: number | null,
>         startDate?: string | null,
>         totalWorkingMinutes?: number | null,
>         unavailableMinutes?: number | null,
>         unavailableUtilization?: number | null,
>         unbillableMinutes?: number | null,
>         utilizationAchieved?: number | null,
>         utilizationTarget?: number | null,
>         utilizationTargetMinutes?: number | null
>       } | null
>     )[] | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null
>   } | null
> )[] | null | null
> ```

***

## Personal Tasks

### create

`personalTasks.create`

Create a personal task.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.personalTasks.create({
	body: {
		task: { name: 'Draft the launch post', dueAt: '2026-01-15' },
		taskOptions: { notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachmentOptions?: {
>     removeOtherFiles?: boolean
>   },
>   attachments?: {
>     files?: {
>       categoryId?: number,
>       id?: number
>     }[],
>     pendingFiles?: {
>       categoryId?: number,
>       reference?: string
>     }[]
>   },
>   predecessors?: {
>     id?: number,
>     type?: string
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   task: {
>     allocationId?: number,
>     assignees?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     attachmentIds?: number[],
>     changeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     commentFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completedAt?: string,
>     completedBy?: number,
>     createdAt?: string,
>     createdBy?: number,
>     crmDealIds?: number[],
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId: number,
>         urlTextToDisplay?: string,
>         value: any
>       }[]
>     } | {
>       countryCode?: string,
>       currencySymbol?: string,
>       customfieldId: number,
>       urlTextToDisplay?: string,
>       value: any
>     }[],
>     descriptionContentType?: string,
>     dueAt?: string,
>     dueDate?: string,
>     estimatedMinutes?: number,
>     grantAccessTo?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     hasDeskTickets?: boolean,
>     name: string,
>     notify?: boolean,
>     originalDueDate?: string,
>     parentTaskId?: number,
>     priority?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: string
>     } | none | "" | low | medium | high,
>     private?: boolean,
>     progress?: number,
>     projectId?: number,
>     reminders?: {
>       isRelative?: boolean,
>       note?: string,
>       relativeNumberDays?: number,
>       remindAt?: string,
>       type?: string,
>       userId?: number
>     }[],
>     repeatOptions?: {
>       duration?: number,
>       editOption?: string,
>       endsAt?: string,
>       frequency?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       monthlyRepeatType?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       rrule?: string,
>       selectedDays?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string[]
>       }
>     },
>     startAt?: string,
>     startDate?: string,
>     status?: string,
>     tagIds?: number[],
>     taskgroupId?: number,
>     tasklistId?: number,
>     templateRoleName?: string,
>     ticketId?: number,
>     description?: string
>   },
>   taskOptions: {
>     appendAssignees?: boolean,
>     checkInvalidusers?: boolean,
>     everyoneMustDo?: boolean,
>     fireWebhook?: boolean,
>     isTemplate?: boolean,
>     logActivity?: boolean,
>     notify: boolean,
>     parseInlineTags?: boolean,
>     positionAfterTaskId?: number,
>     pushDependents?: boolean,
>     pushSubtasks?: boolean,
>     shiftProjectDates?: boolean,
>     useDefaults?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   workflows?: {
>     positionAfterTask?: number,
>     stageId?: number,
>     workflowId?: number
>   },
>   card?: {
>     columnId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### get

`personalTasks.get`

Get one personal task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.personalTasks.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedBefore?: string,
>   updatedAfter?: string,
>   today?: string,
>   taskFilter?: all | anytime | completed | created | overdue | today | yesterday | started | tomorrow | thisweek | within7 | within14 | within30 | within365 | nodate | noduedate | nostartdate | newTaskDefaults | hasDate | upcoming | within | withinprev,
>   startDate?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | task | tasktime,
>   reportFormat?: html | pdf | csv | xls | xlsx | google-sheets,
>   projectType?: all | normal | tentative | personal | projects-template | tasklists-template,
>   priority?: string,
>   orderMode?: asc | desc,
>   orderBy?: id | startdate | createdat | priority | project | flattenedtasklist | company | manual | active | completedat | duestartdate | alldates | tasklistname | tasklistdisplayorder | tasklistid | duedate | updatedat | taskname | createdby | completedby | assignedto | taskstatus | taskduedate | customfield | estimatedtime | taskgroupid | taskgroupname | projectmanual | stagedisplayorder | stage | parenttask | dateadded | datecompleted | completedatdesc | completeddatedesc | duestartdatedesc | alldatesdesc | duedatedesc | taskgroupdisplayorder | dateupdated | originalduedate | tags,
>   notCompletedBefore?: string,
>   endDate?: string,
>   dueBefore?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   createdFilter?: anytime | today | yesterday | custom,
>   createdDateCode?: string,
>   createdBefore?: string,
>   createdAfter?: string,
>   completedBefore?: string,
>   completedAfter?: string,
>   updatedByUserId?: number,
>   parentTaskId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   includeTaskId?: number,
>   filterId?: number,
>   completedByUserId?: number,
>   useTaskDateRange?: boolean,
>   useStartDatesForTodaysTasks?: boolean,
>   useFormulaFields?: boolean,
>   useAllProjects?: boolean,
>   sortActiveFirst?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   showCompletedLists?: boolean,
>   searchJobRoles?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   onlyUntaggedTasks?: boolean,
>   onlyUnplanned?: boolean,
>   onlyUnassignedTasks?: boolean,
>   onlyTasksWithUnreadComments?: boolean,
>   onlyTasksWithTickets?: boolean,
>   onlyTasksWithEstimatedTime?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyAssignedTasks?: boolean,
>   onlyAssignedRoleTasks?: boolean,
>   onlyAdminProjects?: boolean,
>   nestSubTasks?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeUntaggedTasks?: boolean,
>   includeTomorrow?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTasksWithoutDueDates?: boolean,
>   includeTasksFromDeletedLists?: boolean,
>   includeTasksCount?: boolean,
>   includeRelatedTasks?: boolean,
>   includePrivateItems?: boolean,
>   includeOverdueTasks?: boolean,
>   includeOriginalDueDate?: boolean,
>   includeJobRoleUserIds?: boolean,
>   includeEmailCommentStats?: boolean,
>   includeCustomFields?: boolean,
>   includeCompletedTasks?: boolean,
>   includeCompletedPredecessors?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeCommentStats?: boolean,
>   includeBlocked?: boolean,
>   includeAttachmentCommentStats?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeJobRoles?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   includeAllComments?: boolean,
>   includeAccumulatedTimeTotals?: boolean,
>   hideDeleted?: boolean,
>   groupByTasklist?: boolean,
>   groupByTaskgroup?: boolean,
>   getSubTasks?: boolean,
>   getFiles?: boolean,
>   fallbackToMilestoneDueDate?: boolean,
>   extractTemplateRoleName?: boolean,
>   excludeAssigneeNotOnProjectTeams?: boolean,
>   excludeAssignedToMe?: boolean,
>   deletedOnly?: boolean,
>   completedOnly?: boolean,
>   checkForTimeblocks?: boolean,
>   checkForReminders?: boolean,
>   calculateTasklistDates?: boolean,
>   allowAssigneesOutsideProject?: boolean,
>   workflowIds?: number[],
>   tasksSelectedColumns?: string[],
>   tasklistIds?: number[],
>   taskgroupIds?: number[],
>   taskIncludedSet?: (overdue | nodate | nostartdate | noduedate | nostartwithfutureduedate | taskListNames | projectNames)[],
>   tags?: string[],
>   tagIds?: number[],
>   status?: (upcoming | late | all)[],
>   stageIds?: number[],
>   sort?: string[],
>   skipCRMDealIds?: number[],
>   selectedColumns?: string[],
>   responsiblePartyIds?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectFeaturesEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   portfolioBoardIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | tasklists | parentTasks | companies | teams | users | milestones | comments | comments.users | tags | timeTotals | accumulatedTimeTotals | taskSequences | commentFollowers | changeFollowers | completeFollowers | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | attachments | attachments.users | subtaskStats | timers | predecessors | permissions | jobRoles | proofs | taskgroups | workflows | workflows.stages | customfields | customfieldTasks | tasks)[],
>   ids?: number[],
>   followedByUserIds?: number[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     taskgroups
>   ]?: (id | name | description | displayOrder | projectId | status)[],
>   fields[
>     taskSequences
>   ]?: (id | installationId | frequency | selectedWeekDays | endDate | monthlyRepeatType | duration | rrule)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     jobroles
>   ]?: (id | name)[],
>   fields[
>     groups
>   ]?: (late | today | tomorrow | later-this-week | next-week | later | no-due-date)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldTasks
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   expandedIds?: number[],
>   excludeTagIds?: number[],
>   excludeResponsiblePartyIds?: number[],
>   crmDealIds?: number[],
>   createdByUserIds?: number[],
>   assigneeTypes?: (user | company | team | jobrole | placeholder | assigned | unassigned)[],
>   assigneeTeamIds?: number[],
>   assigneeJobRoleIds?: number[],
>   assigneeCompanyIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### list

`personalTasks.list`

List the current user's personal tasks.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.personalTasks.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedBefore?: string,
>   updatedAfter?: string,
>   today?: string,
>   taskFilter?: all | anytime | completed | created | overdue | today | yesterday | started | tomorrow | thisweek | within7 | within14 | within30 | within365 | nodate | noduedate | nostartdate | newTaskDefaults | hasDate | upcoming | within | withinprev,
>   startDate?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | task | tasktime,
>   reportFormat?: html | pdf | csv | xls | xlsx | google-sheets,
>   projectType?: all | normal | tentative | personal | projects-template | tasklists-template,
>   priority?: string,
>   orderMode?: asc | desc,
>   orderBy?: id | startdate | createdat | priority | project | flattenedtasklist | company | manual | active | completedat | duestartdate | alldates | tasklistname | tasklistdisplayorder | tasklistid | duedate | updatedat | taskname | createdby | completedby | assignedto | taskstatus | taskduedate | customfield | estimatedtime | taskgroupid | taskgroupname | projectmanual | stagedisplayorder | stage | parenttask | dateadded | datecompleted | completedatdesc | completeddatedesc | duestartdatedesc | alldatesdesc | duedatedesc | taskgroupdisplayorder | dateupdated | originalduedate | tags,
>   notCompletedBefore?: string,
>   endDate?: string,
>   dueBefore?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   createdFilter?: anytime | today | yesterday | custom,
>   createdDateCode?: string,
>   createdBefore?: string,
>   createdAfter?: string,
>   completedBefore?: string,
>   completedAfter?: string,
>   updatedByUserId?: number,
>   parentTaskId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   includeTaskId?: number,
>   filterId?: number,
>   completedByUserId?: number,
>   useTaskDateRange?: boolean,
>   useStartDatesForTodaysTasks?: boolean,
>   useFormulaFields?: boolean,
>   useAllProjects?: boolean,
>   sortActiveFirst?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   showCompletedLists?: boolean,
>   searchJobRoles?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   onlyUntaggedTasks?: boolean,
>   onlyUnplanned?: boolean,
>   onlyUnassignedTasks?: boolean,
>   onlyTasksWithUnreadComments?: boolean,
>   onlyTasksWithTickets?: boolean,
>   onlyTasksWithEstimatedTime?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyAssignedTasks?: boolean,
>   onlyAssignedRoleTasks?: boolean,
>   onlyAdminProjects?: boolean,
>   nestSubTasks?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeUntaggedTasks?: boolean,
>   includeTomorrow?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTasksWithoutDueDates?: boolean,
>   includeTasksFromDeletedLists?: boolean,
>   includeTasksCount?: boolean,
>   includeRelatedTasks?: boolean,
>   includePrivateItems?: boolean,
>   includeOverdueTasks?: boolean,
>   includeOriginalDueDate?: boolean,
>   includeJobRoleUserIds?: boolean,
>   includeEmailCommentStats?: boolean,
>   includeCustomFields?: boolean,
>   includeCompletedTasks?: boolean,
>   includeCompletedPredecessors?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeCommentStats?: boolean,
>   includeBlocked?: boolean,
>   includeAttachmentCommentStats?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeJobRoles?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   includeAllComments?: boolean,
>   includeAccumulatedTimeTotals?: boolean,
>   hideDeleted?: boolean,
>   groupByTasklist?: boolean,
>   groupByTaskgroup?: boolean,
>   getSubTasks?: boolean,
>   getFiles?: boolean,
>   fallbackToMilestoneDueDate?: boolean,
>   extractTemplateRoleName?: boolean,
>   excludeAssigneeNotOnProjectTeams?: boolean,
>   excludeAssignedToMe?: boolean,
>   deletedOnly?: boolean,
>   completedOnly?: boolean,
>   checkForTimeblocks?: boolean,
>   checkForReminders?: boolean,
>   calculateTasklistDates?: boolean,
>   allowAssigneesOutsideProject?: boolean,
>   workflowIds?: number[],
>   tasksSelectedColumns?: string[],
>   tasklistIds?: number[],
>   taskgroupIds?: number[],
>   taskIncludedSet?: (overdue | nodate | nostartdate | noduedate | nostartwithfutureduedate | taskListNames | projectNames)[],
>   tags?: string[],
>   tagIds?: number[],
>   status?: (upcoming | late | all)[],
>   stageIds?: number[],
>   sort?: string[],
>   skipCRMDealIds?: number[],
>   selectedColumns?: string[],
>   responsiblePartyIds?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectFeaturesEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   portfolioBoardIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | tasklists | parentTasks | companies | teams | users | milestones | comments | comments.users | tags | timeTotals | accumulatedTimeTotals | taskSequences | commentFollowers | changeFollowers | completeFollowers | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | attachments | attachments.users | subtaskStats | timers | predecessors | permissions | jobRoles | proofs | taskgroups | workflows | workflows.stages | customfields | customfieldTasks | tasks)[],
>   ids?: number[],
>   followedByUserIds?: number[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     taskgroups
>   ]?: (id | name | description | displayOrder | projectId | status)[],
>   fields[
>     taskSequences
>   ]?: (id | installationId | frequency | selectedWeekDays | endDate | monthlyRepeatType | duration | rrule)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     jobroles
>   ]?: (id | name)[],
>   fields[
>     groups
>   ]?: (late | today | tomorrow | later-this-week | next-week | later | no-due-date)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldTasks
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   expandedIds?: number[],
>   excludeTagIds?: number[],
>   excludeResponsiblePartyIds?: number[],
>   crmDealIds?: number[],
>   createdByUserIds?: number[],
>   assigneeTypes?: (user | company | team | jobrole | placeholder | assigned | unassigned)[],
>   assigneeTeamIds?: number[],
>   assigneeJobRoleIds?: number[],
>   assigneeCompanyIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `tasks` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> (
>   {
>     accumulatedEstimatedMinutes?: number | null,
>     assigneeCompanies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeCompanyIds?: (number | null)[] | null,
>     assigneeJobRoleIds?: (number | null)[] | null,
>     assigneeJobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeTeamIds?: (number | null)[] | null,
>     assigneeTeams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeUserIds?: (number | null)[] | null,
>     assigneeUsers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assignees?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     attachments?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     capacities?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     changeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     column?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     commentFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     completedOn?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserId?: number | null,
>     crmDealIds?: (number | null)[] | null,
>     dateUpdated?: string | null,
>     decimalDisplayOrder?: number | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     dependencyIds?: (number | null)[] | null,
>     descriptionContentType?: string | null,
>     displayOrder?: number | null,
>     dueDate?: string | null,
>     dueDateBase?: string | null,
>     dueDateFromMilestone?: boolean | null,
>     dueDateOffset?: number | null,
>     estimateMinutes?: number | null,
>     hasDeskTickets?: boolean | null,
>     hasReminders?: boolean | null,
>     hasTimeblocks?: boolean | null,
>     id?: number | null,
>     isArchived?: boolean | null,
>     isBlocked?: boolean | null,
>     isPrivate?: number | null,
>     latestUpdates?: (
>       {
>         after?: any | null,
>         before?: any | null,
>         field?: string | null
>       } | null
>     )[] | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     meta?: {
>       commentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null,
>       emailCommentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null
>     } | null,
>     name?: string | null,
>     notify?: boolean | null,
>     originalDueDate?: string | null,
>     outOfSequence?: boolean | null,
>     parentTask?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     parentTaskId?: number | null,
>     predecessorIds?: (number | null)[] | null,
>     predecessors?: (
>       {
>         id?: number | null,
>         meta?: {
>           dependancyHardness?: string | null,
>           predecessorTaskMust?: string | null,
>           predecessorType?: string | null,
>           projectId?: string | null,
>           tasklistId?: string | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     priority?: string | null,
>     progress?: number | null,
>     proofs?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     sequence?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     sequenceDueDate?: string | null,
>     sequenceId?: number | null,
>     sequenceRootTask?: boolean | null,
>     sequenceStartDate?: string | null,
>     startDate?: string | null,
>     startDateOffset?: number | null,
>     status?: string | null,
>     subTaskIds?: (number | null)[] | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasklist?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectId?: number | null,
>         projectName?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     tasklistId?: number | null,
>     templateRoleName?: string | null,
>     timer?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     userPermissions?: {
>       canAddSubtasks?: boolean | null,
>       canComplete?: boolean | null,
>       canEdit?: boolean | null,
>       canLogTime?: boolean | null,
>       canViewEstTime?: boolean | null
>     } | null,
>     workflowStages?: (
>       {
>         stageId?: number | null,
>         stageTaskDisplayOrder?: number | null,
>         workflowId?: number | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

## Portfolio Boards

### create

`portfolioBoards.create`

Create a portfolio board.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.portfolioBoards.create({
	body: {
		board: { name: 'Client projects', color: '#4461D7' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   board?: {
>     name?: string,
>     color?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `id` | `string \| number \| boolean \| null` | No | — |

***

### delete

`portfolioBoards.delete`

Delete a portfolio board.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.portfolioBoards.delete({
	path: { boardId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   boardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### list

`portfolioBoards.list`

List portfolio boards.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.portfolioBoards.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `boards` | `object[] \| null` | No | — |

> [accordion] boards full type
>
> ```ts theme={null}
> (
>   {
>     canEdit?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     displayOrder?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     color?: string | number | boolean | null,
>     stats?: {
>       projects?: string | number | boolean | null
>     } | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### update

`portfolioBoards.update`

Update a portfolio board.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.portfolioBoards.update({
	path: { boardId: '1' },
	body: {
		board: { name: 'Client projects 2027' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   boardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   board?: {
>     name?: string,
>     color?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Portfolio Cards

### add

`portfolioCards.add`

Add a project to a portfolio column.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.portfolioCards.add({
	path: { columnId: '1' },
	body: {
		card: { projectId: '1470497' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   columnId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   card?: {
>     projectId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `cardId` | `string \| number \| boolean \| null` | No | — |
| `projectId` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`portfolioCards.delete`

Remove a project card from a portfolio column.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.portfolioCards.delete({
	path: { cardId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   cardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`portfolioCards.get`

Get one portfolio card.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.portfolioCards.get({
	path: { cardId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   cardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `column` | `object \| null` | No | — |
| `card` | `object \| null` | No | — |

> [accordion] column full type
>
> ```ts theme={null}
> {
>   color?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   name?: string | number | boolean | null
> } | null
> ```

> [accordion] card full type
>
> ```ts theme={null}
> {
>   canEdit?: string | number | boolean | null,
>   startDate?: string | number | boolean | null,
>   boardId?: string | number | boolean | null,
>   starred?: string | number | boolean | null,
>   displayOrder?: string | number | boolean | null,
>   deleted?: string | number | boolean | null,
>   columnId?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   endDate?: string | number | boolean | null,
>   company?: {
>     id?: string | number | boolean | null,
>     name?: string | number | boolean | null
>   } | null,
>   dateUpdated?: string | number | boolean | null,
>   status?: string | number | boolean | null,
>   owner?: {
>     lastName?: string | number | boolean | null,
>     firstName?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     fullName?: string | number | boolean | null,
>     avatarUrl?: string | number | boolean | null
>   } | null,
>   deletedDate?: string | number | boolean | null,
>   projectId?: string | number | boolean | null,
>   category?: {
>     color?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     name?: string | number | boolean | null
>   } | null,
>   progress?: {
>   } | null,
>   update?: {
>     deletedDate?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     color?: string | number | boolean | null,
>     text?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     health?: string | number | boolean | null,
>     deleted?: string | number | boolean | null,
>     user?: {
>       lastName?: string | number | boolean | null,
>       firstName?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       fullName?: string | number | boolean | null,
>       avatarUrl?: string | number | boolean | null
>     } | null,
>     dateCreated?: string | number | boolean | null
>   } | null,
>   id?: string | number | boolean | null,
>   archived?: string | number | boolean | null,
>   dateCreated?: string | number | boolean | null,
>   tags?: (
>     {
>     } | null
>   )[] | null
> } | null
> ```

***

### list

`portfolioCards.list`

List the project cards in a portfolio column.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.portfolioCards.list({
	path: { columnId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   columnId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `column` | `object \| null` | No | — |
| `cards` | `object[] \| null` | No | — |

> [accordion] column full type
>
> ```ts theme={null}
> {
>   name?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   color?: string | number | boolean | null
> } | null
> ```

> [accordion] cards full type
>
> ```ts theme={null}
> (
>   {
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     starred?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     columnId?: string | number | boolean | null,
>     boardId?: string | number | boolean | null,
>     displayOrder?: string | number | boolean | null,
>     archived?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     status?: string | number | boolean | null,
>     category?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       color?: string | number | boolean | null
>     } | null,
>     canEdit?: string | number | boolean | null,
>     tags?: (
>       {
>       } | null
>     )[] | null,
>     startDate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     deleted?: string | number | boolean | null,
>     endDate?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### move

`portfolioCards.move`

Move a project card to another column.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.portfolioCards.move({
	path: { cardId: '1' },
	body: {
		cardId: '1',
		columnId: '2',
		oldColumnId: '1',
		positionAfterId: 0,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   cardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cardId?: string,
>   positionAfterId?: number,
>   columnId?: string,
>   oldColumnId?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Portfolio Columns

### create

`portfolioColumns.create`

Add a column to a portfolio board.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.portfolioColumns.create({
	path: { boardId: '1' },
	body: {
		column: { name: 'In progress', color: '#4461D7' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   boardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   column?: {
>     color?: string,
>     name?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`portfolioColumns.delete`

Delete a portfolio column.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.portfolioColumns.delete({
	path: { columnId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   columnId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`portfolioColumns.get`

Get one portfolio column.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.portfolioColumns.get({
	path: { columnId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   columnId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `column` | `object \| null` | No | — |

> [accordion] column full type
>
> ```ts theme={null}
> {
>   name?: string | number | boolean | null,
>   displayOrder?: string | number | boolean | null,
>   sortOrder?: string | number | boolean | null,
>   deletedDate?: string | number | boolean | null,
>   dateUpdated?: string | number | boolean | null,
>   settings?: {
>     company?: string | number | boolean | null,
>     update?: string | number | boolean | null,
>     category?: string | number | boolean | null,
>     starred?: string | number | boolean | null,
>     tags?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     progress?: string | number | boolean | null,
>     dates?: string | number | boolean | null,
>     owner?: string | number | boolean | null
>   } | null,
>   hasTriggers?: string | number | boolean | null,
>   sort?: string | number | boolean | null,
>   canEdit?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   dateCreated?: string | number | boolean | null,
>   color?: string | number | boolean | null,
>   deleted?: string | number | boolean | null
> } | null
> ```

***

### list

`portfolioColumns.list`

List the columns of a portfolio board.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.portfolioColumns.list({
	path: { boardId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   boardId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `columns` | `object[] \| null` | No | — |
| `board` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] columns full type
>
> ```ts theme={null}
> (
>   {
>     name?: string | number | boolean | null,
>     displayOrder?: string | number | boolean | null,
>     sortOrder?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     settings?: {
>       company?: string | number | boolean | null,
>       category?: string | number | boolean | null,
>       starred?: string | number | boolean | null,
>       tags?: string | number | boolean | null,
>       name?: string | number | boolean | null,
>       dates?: string | number | boolean | null
>     } | null,
>     hasTriggers?: string | number | boolean | null,
>     sort?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     color?: string | number | boolean | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] board full type
>
> ```ts theme={null}
> {
>   name?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   color?: string | number | boolean | null,
>   deleted?: string | number | boolean | null
> } | null
> ```

***

## Project Categories

### create

`projectCategories.create`

Create a project category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projectCategories.create({
	body: {
		category: { name: 'Client work' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `categoryId` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`projectCategories.delete`

Delete a project category.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectCategories.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`projectCategories.get`

Get one project category.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectCategories.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] category full type
>
> ```ts theme={null}
> {
>   parent-id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   count?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   elements_count?: string | number | boolean | null,
>   color?: string | number | boolean | null,
>   type?: string | number | boolean | null
> } | null
> ```

***

### list

`projectCategories.list`

List project categories.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectCategories.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `categories` | `object[] \| null` | No | — |

> [accordion] categories full type
>
> ```ts theme={null}
> (
>   {
>     parent-id?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     elements-count?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     color?: string | number | boolean | null,
>     type?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### update

`projectCategories.update`

Rename or move a project category.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projectCategories.update({
	path: { id: '56260' },
	body: {
		category: { name: 'Client projects' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   category?: {
>     name?: string,
>     parent-id?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Project Metrics

### billable

`projectMetrics.billable`

Total billable time per project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectMetrics.billable({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   startDate: string,
>   orderMode?: asc | desc,
>   endDate: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[] \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> (
>   {
>     name?: string | null,
>     value?: number | null
>   } | null
> )[] | null
> ```

***

### health

`projectMetrics.health`

Health summary across projects.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectMetrics.health({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   projectStatus?: active | current | late | upcoming | completed | deleted,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[] \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> (
>   {
>     name?: string | null,
>     value?: number | null
>   } | null
> )[] | null
> ```

***

### invoices

`projectMetrics.invoices`

Open invoices across projects.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectMetrics.invoices({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeArchivedProjects?: boolean,
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   value?: number | null
> } | null
> ```

***

### unbilled

`projectMetrics.unbilled`

Unbilled expenses across projects.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectMetrics.unbilled({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeArchivedProjects?: boolean,
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   value?: number | null
> } | null
> ```

***

## Project People

### add

`projectPeople.add`

Add people to a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projectPeople.add({
	path: { projectId: 1 },
	body: {
		userIds: [1],
		checkTeamIds: [1],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   checkTeamIds?: number[],
>   userIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `info` | `(string \| null)[] \| null` | No | — |
| `teamIds` | `(number \| null)[] \| null` | No | — |
| `usersAdded` | `(number \| null)[] \| null` | No | — |
| `usersAlreadyInProject` | `(number \| null)[] \| null` | No | — |
| `usersNotAdded` | `(number \| null)[] \| null` | No | — |

***

### get

`projectPeople.get`

Get one person's membership on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectPeople.get({
	path: { projectId: 1, personId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number,
>   personId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userType?: account | collaborator | contact | client,
>   updatedAfter?: string,
>   searchTerm?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | namecaseinsensitive | company | id | providedids | dateupdated,
>   lastLoginAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   searchUserSkill?: boolean,
>   searchUserJobRole?: boolean,
>   orderPrioritiseCurrentUser?: boolean,
>   onlySiteOwner?: boolean,
>   onlyPlaceholders?: boolean,
>   onlyOwnerCompany?: boolean,
>   inclusiveFilter?: boolean,
>   includeStandardUsers?: boolean,
>   includeServiceAccounts?: boolean,
>   includePlaceholders?: boolean,
>   includeObservers?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   filterByNoCostRate?: boolean,
>   excludeContacts?: boolean,
>   clientPortalEligible?: boolean,
>   adminsOnly?: boolean,
>   teamIds?: number[],
>   skillIds?: number[],
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   notLinkedWithClientPortalIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | workingHours | currencies | teams | jobRoles | skills | linkedClientPortalCompanies | projects.permissions | permissions | users.integrations | skillCounts)[],
>   ids?: number[],
>   fields[
>     userIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     people
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeProjectIds?: number[],
>   excludeIds?: number[],
>   excludeAllocatedUsersProjectIDs?: number[],
>   emails?: string[],
>   companyIds?: number[],
>   SkillLevels?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `person` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   linkedClientPortalCompanies?: {
>   } | null,
>   skills?: {
>   } | null,
>   teams?: {
>   } | null,
>   userIntegrations?: {
>   } | null,
>   workingHours?: {
>   } | null
> } | null
> ```

> [accordion] person full type
>
> ```ts theme={null}
> {
>   avatarUrl?: string | null,
>   canAccessPortfolio?: boolean | null,
>   canAddProjects?: boolean | null,
>   canManagePortfolio?: boolean | null,
>   company?: {
>     id?: number | null,
>     meta?: {
>       name?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   companyId?: number | null,
>   companyRoleId?: number | null,
>   createdAt?: string | null,
>   createdBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   deleted?: boolean | null,
>   email?: string | null,
>   firstName?: string | null,
>   id?: number | null,
>   inOwnerCompany?: boolean | null,
>   isAdmin?: boolean | null,
>   isClientUser?: boolean | null,
>   isPlaceholderResource?: boolean | null,
>   isServiceAccount?: boolean | null,
>   jobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   lastLogin?: string | null,
>   lastName?: string | null,
>   lengthOfDay?: number | null,
>   linkedClientPortalCompany?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   linkedClientPortalCompanyId?: number | null,
>   loginTarget?: string | null,
>   meta?: {
>   } | null,
>   siteOwner?: boolean | null,
>   skills?: (
>     {
>       id?: number | null,
>       meta?: {
>         level?: number | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   teams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   timezone?: string | null,
>   type?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userCost?: number | null,
>   userRate?: number | null,
>   userRates?: {
>   } | null,
>   workingHour?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   workingHoursId?: number | null
> } | null
> ```

***

### getPermissions

`projectPeople.getPermissions`

Get a person's permissions on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectPeople.getPermissions({
	path: { projectId: 1, personId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number,
>   personId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `people` | `object[] \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] people full type
>
> ```ts theme={null}
> (
>   {
>     administrator?: string | number | boolean | null,
>     address-city?: string | number | boolean | null,
>     pid?: string | number | boolean | null,
>     site-owner?: string | number | boolean | null,
>     twitter?: string | number | boolean | null,
>     phone-number-home?: string | number | boolean | null,
>     last-name?: string | number | boolean | null,
>     email-address?: string | number | boolean | null,
>     userUUID?: string | number | boolean | null,
>     user-name?: string | number | boolean | null,
>     company-name?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     last-changed-on?: string | number | boolean | null,
>     phone-number-office?: string | number | boolean | null,
>     deleted?: string | number | boolean | null,
>     address-state?: string | number | boolean | null,
>     address-country?: string | number | boolean | null,
>     notes?: string | number | boolean | null,
>     phone-number-mobile?: string | number | boolean | null,
>     first-name?: string | number | boolean | null,
>     user-type?: string | number | boolean | null,
>     permissions?: {
>       add-tasks?: string | number | boolean | null,
>       view-time?: string | number | boolean | null,
>       add-messages?: string | number | boolean | null,
>       view-messages-and-files?: string | number | boolean | null,
>       view-estimated-time?: string | number | boolean | null,
>       view-tasks-and-milestones?: string | number | boolean | null,
>       add-links?: string | number | boolean | null,
>       view-notebooks?: string | number | boolean | null,
>       view-invoices?: string | number | boolean | null,
>       edit-all-tasks?: string | number | boolean | null,
>       set-privacy?: string | number | boolean | null,
>       add-milestones?: string | number | boolean | null,
>       add-time?: string | number | boolean | null,
>       is-observing?: string | number | boolean | null,
>       view-all-time-logs?: string | number | boolean | null,
>       add-taskLists?: string | number | boolean | null,
>       project-administrator?: string | number | boolean | null,
>       can-be-assigned-to-tasks-and-milestones?: string | number | boolean | null,
>       view-links?: string | number | boolean | null,
>       add-files?: string | number | boolean | null,
>       can-receive-email?: string | number | boolean | null,
>       add-notebooks?: string | number | boolean | null,
>       add-people-to-project?: string | number | boolean | null,
>       view-risk-register?: string | number | boolean | null
>     } | null,
>     im-service?: string | number | boolean | null,
>     im-handle?: string | number | boolean | null,
>     address-line-2?: string | number | boolean | null,
>     address-line-1?: string | number | boolean | null,
>     created-at?: string | number | boolean | null,
>     phone-number-office-ext?: string | number | boolean | null,
>     company-id?: string | number | boolean | null,
>     has-access-to-new-projects?: string | number | boolean | null,
>     address-zip?: string | number | boolean | null,
>     phone-number-fax?: string | number | boolean | null,
>     avatar-url?: string | number | boolean | null,
>     in-owner-company?: string | number | boolean | null,
>     last-login?: string | number | boolean | null,
>     email-alt-1?: string | number | boolean | null,
>     email-alt-2?: string | number | boolean | null,
>     companyId?: string | number | boolean | null,
>     email-alt-3?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### list

`projectPeople.list`

List the people on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectPeople.list({
	path: { projectId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userType?: account | collaborator | contact | client,
>   updatedAfter?: string,
>   searchTerm?: string,
>   orderMode?: asc | desc,
>   orderBy?: name | namecaseinsensitive | company | id | providedids | dateupdated,
>   lastLoginAfter?: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   searchUserSkill?: boolean,
>   searchUserJobRole?: boolean,
>   orderPrioritiseCurrentUser?: boolean,
>   onlySiteOwner?: boolean,
>   onlyPlaceholders?: boolean,
>   onlyOwnerCompany?: boolean,
>   inclusiveFilter?: boolean,
>   includeStandardUsers?: boolean,
>   includeServiceAccounts?: boolean,
>   includePlaceholders?: boolean,
>   includeObservers?: boolean,
>   includeCollaborators?: boolean,
>   includeClients?: boolean,
>   filterByNoCostRate?: boolean,
>   excludeContacts?: boolean,
>   clientPortalEligible?: boolean,
>   adminsOnly?: boolean,
>   teamIds?: number[],
>   skillIds?: number[],
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   notLinkedWithClientPortalIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | workingHours | currencies | teams | jobRoles | skills | linkedClientPortalCompanies | projects.permissions | permissions | users.integrations | skillCounts)[],
>   ids?: number[],
>   fields[
>     userIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     person
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     people
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeProjectIds?: number[],
>   excludeIds?: number[],
>   excludeAllocatedUsersProjectIDs?: number[],
>   emails?: string[],
>   companyIds?: number[],
>   SkillLevels?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `failed` | `object[] \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `people` | `object[] \| null` | No | — |

> [accordion] failed full type
>
> ```ts theme={null}
> (
>   {
>     errors?: (
>       {
>         code?: string | null,
>         detail?: string | null,
>         id?: string | null,
>         meta?: {
>         } | null
>       } | null
>     )[] | null,
>     index?: number | null
>   } | null
> )[] | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   linkedClientPortalCompanies?: {
>   } | null,
>   skills?: {
>   } | null,
>   teams?: {
>   } | null,
>   userIntegrations?: {
>   } | null,
>   workingHours?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   skillCounts?: {
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] people full type
>
> ```ts theme={null}
> (
>   {
>     avatarUrl?: string | null,
>     canAccessPortfolio?: boolean | null,
>     canAddProjects?: boolean | null,
>     canManagePortfolio?: boolean | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     companyRoleId?: number | null,
>     createdAt?: string | null,
>     createdBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     deleted?: boolean | null,
>     email?: string | null,
>     firstName?: string | null,
>     id?: number | null,
>     inOwnerCompany?: boolean | null,
>     isAdmin?: boolean | null,
>     isClientUser?: boolean | null,
>     isPlaceholderResource?: boolean | null,
>     isServiceAccount?: boolean | null,
>     jobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     lastLogin?: string | null,
>     lastName?: string | null,
>     lengthOfDay?: number | null,
>     linkedClientPortalCompany?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     linkedClientPortalCompanyId?: number | null,
>     loginTarget?: string | null,
>     meta?: {
>     } | null,
>     siteOwner?: boolean | null,
>     skills?: (
>       {
>         id?: number | null,
>         meta?: {
>           level?: number | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     teams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     timezone?: string | null,
>     type?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userCost?: number | null,
>     userRate?: number | null,
>     userRates?: {
>     } | null,
>     workingHour?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     workingHoursId?: number | null
>   } | null
> )[] | null
> ```

***

### remove

`projectPeople.remove`

Remove a person from a project.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectPeople.remove({
	path: { projectId: 1, personId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number,
>   personId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Project Roles

### delete

`projectRoles.delete`

Delete a project role.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectRoles.delete({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`projectRoles.get`

Get one project role.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectRoles.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `role` | `object \| null` | No | — |

> [accordion] role full type
>
> ```ts theme={null}
> {
>   users?: (
>     {
>       firstname?: string | number | boolean | null,
>       id?: string | number | boolean | null,
>       userimage?: string | number | boolean | null,
>       lastname?: string | number | boolean | null
>     } | null
>   )[] | null,
>   name?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   projectId?: string | number | boolean | null
> } | null
> ```

***

### list

`projectRoles.list`

List the roles on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectRoles.list({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `roles` | `object[] \| null` | No | — |

> [accordion] roles full type
>
> ```ts theme={null}
> (
>   {
>     users?: (
>       {
>         firstname?: string | number | boolean | null,
>         id?: string | number | boolean | null,
>         userimage?: string | number | boolean | null,
>         lastname?: string | number | boolean | null
>       } | null
>     )[] | null,
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### update

`projectRoles.update`

Update a project role.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projectRoles.update({
	path: { id: 1 },
	body: {
		role: { name: 'Reviewer', users: '753865' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   role?: {
>     users?: string,
>     name?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Projects

### clone

`projects.clone`

Copy a project, optionally with its tasks, milestones and people.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.clone({
	path: { id: '1470497' },
	body: {
		cloneProjectName: 'Website relaunch (copy)',
		copyTasks: true,
		copyTasklists: true,
		copyMilestones: true,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cloneProjectName?: string,
>   cloneProjectAction?: COPY | MOVE,
>   companyId?: number,
>   copyFiles?: boolean,
>   copyMessages?: boolean,
>   copyMilestones?: boolean,
>   copyTasks?: boolean,
>   copyTasklists?: boolean,
>   copyNotebooks?: boolean,
>   copyLinks?: boolean,
>   copyComments?: boolean,
>   copyFollowers?: boolean,
>   copyInvoices?: boolean,
>   copyTimelogs?: boolean,
>   copyExpenses?: boolean,
>   copyWebhooks?: boolean,
>   copyProjectRoles?: boolean,
>   copyCustomFields?: boolean,
>   copyCustomItems?: boolean,
>   copyProjectUpdates?: boolean,
>   copyRisks?: boolean,
>   copyForms?: boolean,
>   copyAutomations?: boolean,
>   copyPeople?: boolean,
>   copyProjectPrivacy?: boolean,
>   copyBudgets?: boolean,
>   copyAllocations?: boolean,
>   copyLogo?: boolean,
>   copyProjectPrefs?: boolean,
>   newFromTemplate?: boolean,
>   toTemplate?: boolean,
>   templateDateTarget?: start | end,
>   targetDate?: string,
>   daysOffset?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `projectId` | `string \| number \| boolean \| null` | No | — |

***

### convertTentative

`projects.convertTentative`

Convert a tentative project into a normal project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.convertTentative({
	path: { projectId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `projects` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projectCategories?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     category?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     categoryId?: number | null,
>     code?: string | null,
>     content?: any | null,
>     icon?: string | null,
>     id?: number | null,
>     imagePreview?: string | null,
>     name?: string | null
>   } | null
> )[] | null
> ```

***

### create

`projects.create`

Create a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.create({
	body: {
		project: { name: 'Website relaunch', description: 'Q1 site rebuild', use-tasks: true },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   project?: {
>     name?: string,
>     use-tasks?: boolean,
>     use-milestones?: boolean,
>     use-messages?: boolean,
>     use-files?: boolean,
>     use-time?: boolean,
>     use-notebook?: boolean,
>     use-riskregister?: boolean,
>     use-links?: boolean,
>     use-billing?: boolean,
>     use-comments?: boolean,
>     category-id?: number,
>     start-date?: string,
>     end-date?: string,
>     tagIds?: string,
>     onboarding?: boolean,
>     grant-access-to?: string,
>     private?: boolean,
>     customFields?: {
>       customFieldId?: number,
>       value?: string
>     }[],
>     people?: number,
>     projectOwnerId?: number,
>     companyId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`projects.delete`

Delete a project.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projects.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`projects.get`

Get one project by id.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.get({
	path: { projectId: 1470497 },
	query: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   timeMode?: timelogs | estimated,
>   searchTerm?: string,
>   reportType?: project | health,
>   reportTimezone?: string,
>   reportFormat?: csv | html | pdf | xls | xlsx | google-sheets,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: creatorname | companyname | datecreated | startdate | duedate | lastactivity | name | namecaseinsensitive | ownercompany | ownername | health | taskcompletion | budgetused | starred | starredcompanyname | starredfirst | mobilespecial | lastworkedon | categoryname | customfield | status | id | projectnumber,
>   notCompletedBefore?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   userId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   minBudgetCapacityUsedPercent?: number,
>   maxBudgetCapacityUsedPercent?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchCompanies?: boolean,
>   searchByLetter?: boolean,
>   searchBudgets?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyProjectsWithExplicitMembership?: boolean,
>   onlyProjectsWithAdminAccess?: boolean,
>   onlyProjectsThatCanLogTime?: boolean,
>   onlyProjectsThatCanAddTasks?: boolean,
>   onlyArchivedProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTabSystemStatus?: boolean,
>   includeSubCategories?: boolean,
>   includeStats?: boolean,
>   includeProjectUserInfo?: boolean,
>   includeProjectProfitability?: boolean,
>   includeProjectDates?: boolean,
>   includeCustomFields?: boolean,
>   includeCounts?: boolean,
>   includeCompletedStatus?: boolean,
>   includeArchivedProjects?: boolean,
>   hideObservedProjects?: boolean,
>   alwaysIncludeFiltering?: boolean,
>   usersWithExplicitMembershipIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | inactive | archived | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectNumbers?: string[],
>   projectNumberCounters?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projectOwners | projectUpdates | companies | companies.countries | companies.industries | companies.currencies | projectCategories | portfolioCards | portfolioBoards | portfolioColumns | tags | customfields | customfieldProjects | projectBudgets | activities.latest | users | createdBy | updatedBy | completedBy | deletedBy | archivedBy | projectEmailDropboxes | workflows | workflows.stages | projecttaskstats)[],
>   filter?: any[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[],
>   fields[
>     projectBudgets
>   ]?: (id | projectId | type | status | capacityUsed | capacity | originatorBudgetId | isRepeating | repeatPeriod | repeatUnit | repeatsRemaining | sequenceNumber | startDateTime | endDateTime | currencyCode | timelogType | expenseType | defaultRate | notificationIds | createdByUserId | dateCreated | updatedUserId | dateUpdated | completedByUserId | dateCompleted | deletedByUserId | dateDeleted)[],
>   fields[
>     portfolioColumns
>   ]?: (id | name | color)[],
>   fields[
>     portfolioCards
>   ]?: (id | columnId | projectId)[],
>   fields[
>     portfolioBoards
>   ]?: (id | name | color)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldProjects
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   featuresEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings | tasks)[],
>   excludeTagIds?: number[],
>   excludeProjectIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `project` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   activities?: {
>   } | null,
>   companies?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldProjects?: {
>   } | null,
>   customfields?: {
>   } | null,
>   industries?: {
>   } | null,
>   portfolioBoards?: {
>   } | null,
>   portfolioCards?: {
>   } | null,
>   portfolioColumns?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectEmailDropboxes?: {
>   } | null,
>   projectTaskStats?: {
>   } | null,
>   projectUpdates?: {
>   } | null,
>   stages?: {
>   } | null,
>   tags?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   integrations?: {
>   } | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   permissions?: {
>   } | null,
>   prevCursor?: string | null,
>   projectProfitability?: {
>   } | null,
>   projectStats?: {
>     active?: number | null,
>     archived?: number | null,
>     complete?: number | null,
>     count?: number | null,
>     current?: number | null,
>     hasEvents?: boolean | null,
>     late?: number | null,
>     noDate?: number | null,
>     starred?: number | null,
>     today?: number | null,
>     upcoming?: number | null
>   } | null,
>   projects?: {
>     active?: number | null,
>     archived?: number | null,
>     completed?: number | null,
>     current?: number | null,
>     late?: number | null,
>     total?: number | null,
>     upcoming?: number | null
>   } | null,
>   stats?: {
>     billing?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     events?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     milestones?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     tasks?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null,
>   user?: {
>     hasProjects?: boolean | null
>   } | null
> } | null
> ```

> [accordion] project full type
>
> ```ts theme={null}
> {
>   activePages?: {
>     billing?: boolean | null,
>     board?: boolean | null,
>     comments?: boolean | null,
>     files?: boolean | null,
>     finance?: boolean | null,
>     forms?: boolean | null,
>     gantt?: boolean | null,
>     links?: boolean | null,
>     list?: boolean | null,
>     messages?: boolean | null,
>     milestones?: boolean | null,
>     notebooks?: boolean | null,
>     proofs?: boolean | null,
>     riskRegister?: boolean | null,
>     schedule?: boolean | null,
>     table?: boolean | null,
>     tasks?: boolean | null,
>     tickets?: boolean | null,
>     time?: boolean | null,
>     timeline?: boolean | null
>   } | null,
>   allowNotifyAnyone?: boolean | null,
>   announcement?: string | null,
>   archivedAt?: string | null,
>   archivedBy?: number | null,
>   budgetCount?: number | null,
>   category?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   categoryId?: number | null,
>   company?: {
>     id?: number | null,
>     meta?: {
>       name?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   companyId?: number | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   customFieldValueIds?: (number | null)[] | null,
>   customfieldValues?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   defaultPrivacy?: string | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   directFileUploadsEnabled?: boolean | null,
>   endAt?: string | null,
>   endDate?: string | null,
>   financialBudget?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   financialBudgetId?: number | null,
>   harvestTimersEnabled?: boolean | null,
>   id?: number | null,
>   integrations?: {
>     googleDrive?: {
>       access?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     oneDriveBusiness?: {
>       account?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     sharepoint?: {
>       account?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     xero?: {
>       baseCurrency?: string | null,
>       connected?: boolean | null,
>       countryCode?: string | null,
>       enabled?: boolean | null,
>       organisation?: string | null
>     } | null
>   } | null,
>   isBillable?: boolean | null,
>   isOnBoardingProject?: boolean | null,
>   isProjectAdmin?: boolean | null,
>   isSampleProject?: boolean | null,
>   isStarred?: boolean | null,
>   lastWorkedOn?: string | null,
>   latestActivity?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   logo?: string | null,
>   logoColor?: string | null,
>   logoIcon?: string | null,
>   minMaxAvailableDates?: {
>     deadlinesFound?: boolean | null,
>     maxEndDate?: string | null,
>     minStartDate?: string | null,
>     suggestedEndDate?: string | null,
>     suggestedStartDate?: string | null
>   } | null,
>   name?: string | null,
>   notifyCommentIncludeCreator?: boolean | null,
>   notifyEveryone?: boolean | null,
>   notifyTaskAssignee?: boolean | null,
>   overviewStartPage?: string | null,
>   ownedBy?: number | null,
>   ownerId?: number | null,
>   portfolioCards?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   privacyEnabled?: boolean | null,
>   projectNumber?: string | null,
>   projectNumberCounter?: number | null,
>   projectOwner?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectOwnerId?: number | null,
>   replyByEmailEnabled?: boolean | null,
>   showAnnouncement?: boolean | null,
>   skipWeekends?: boolean | null,
>   startAt?: string | null,
>   startDate?: string | null,
>   startPage?: string | null,
>   status?: string | null,
>   subStatus?: string | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasksStartPage?: string | null,
>   timeBudget?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeBudgetId?: number | null,
>   timelogRequiresTask?: boolean | null,
>   type?: string | null,
>   update?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updateId?: number | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   users?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   workflowIds?: (number | null)[] | null,
>   workflows?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null
> } | null
> ```

***

### getRates

`projects.getRates`

Get a project's billable rates per user.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.getRates({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   page?: number,
>   pageSize?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `rates` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] rates full type
>
> ```ts theme={null}
> {
>   users?: {
>     12345?: {
>       source?: string | number | boolean | null,
>       rate?: string | number | boolean | null
>     } | null
>   } | null,
>   account-default?: string | number | boolean | null,
>   project-default?: string | number | boolean | null
> } | null
> ```

***

### getStats

`projects.getStats`

Get task and milestone counts for a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.getStats({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   responsible-party-ids?: string,
>   onlymyprojects?: boolean,
>   forStarredProjects?: boolean,
>   onlyMyEvents?: boolean,
>   getPermissions?: boolean,
>   eventsInNext?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `stats` | `object \| null` | No | — |

> [accordion] stats full type
>
> ```ts theme={null}
> {
>   tasks?: {
>     nodate?: string | number | boolean | null,
>     today?: string | number | boolean | null,
>     late?: string | number | boolean | null,
>     complete?: string | number | boolean | null,
>     upcoming?: string | number | boolean | null,
>     active?: string | number | boolean | null
>   } | null,
>   columns?: {
>     count?: string | number | boolean | null
>   } | null,
>   billing?: {
>     completed?: string | number | boolean | null,
>     active?: string | number | boolean | null
>   } | null,
>   events?: {
>     today?: string | number | boolean | null,
>     count?: string | number | boolean | null,
>     hasEvents?: string | number | boolean | null
>   } | null,
>   milestones?: {
>     today?: string | number | boolean | null,
>     late?: string | number | boolean | null,
>     complete?: string | number | boolean | null,
>     upcoming?: string | number | boolean | null,
>     active?: string | number | boolean | null
>   } | null
> } | null
> ```

***

### list

`projects.list`

List projects. Filter with projectIds, projectCompanyIds, projectCategoryIds, projectStatuses, searchTerm and more.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.list({
	query: { searchTerm: 'launch', pageSize: 50 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   timeMode?: timelogs | estimated,
>   searchTerm?: string,
>   reportType?: project | health,
>   reportTimezone?: string,
>   reportFormat?: csv | html | pdf | xls | xlsx | google-sheets,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: creatorname | companyname | datecreated | startdate | duedate | lastactivity | name | namecaseinsensitive | ownercompany | ownername | health | taskcompletion | budgetused | starred | starredcompanyname | starredfirst | mobilespecial | lastworkedon | categoryname | customfield | status | id | projectnumber,
>   notCompletedBefore?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   userId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   minBudgetCapacityUsedPercent?: number,
>   maxBudgetCapacityUsedPercent?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchCompanies?: boolean,
>   searchByLetter?: boolean,
>   searchBudgets?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyProjectsWithExplicitMembership?: boolean,
>   onlyProjectsWithAdminAccess?: boolean,
>   onlyProjectsThatCanLogTime?: boolean,
>   onlyProjectsThatCanAddTasks?: boolean,
>   onlyArchivedProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTabSystemStatus?: boolean,
>   includeSubCategories?: boolean,
>   includeStats?: boolean,
>   includeProjectUserInfo?: boolean,
>   includeProjectProfitability?: boolean,
>   includeProjectDates?: boolean,
>   includeCustomFields?: boolean,
>   includeCounts?: boolean,
>   includeCompletedStatus?: boolean,
>   includeArchivedProjects?: boolean,
>   hideObservedProjects?: boolean,
>   alwaysIncludeFiltering?: boolean,
>   usersWithExplicitMembershipIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | inactive | archived | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectNumbers?: string[],
>   projectNumberCounters?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projectOwners | projectUpdates | companies | companies.countries | companies.industries | companies.currencies | projectCategories | portfolioCards | portfolioBoards | portfolioColumns | tags | customfields | customfieldProjects | projectBudgets | activities.latest | users | createdBy | updatedBy | completedBy | deletedBy | archivedBy | projectEmailDropboxes | workflows | workflows.stages | projecttaskstats)[],
>   filter?: any[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[],
>   fields[
>     projectBudgets
>   ]?: (id | projectId | type | status | capacityUsed | capacity | originatorBudgetId | isRepeating | repeatPeriod | repeatUnit | repeatsRemaining | sequenceNumber | startDateTime | endDateTime | currencyCode | timelogType | expenseType | defaultRate | notificationIds | createdByUserId | dateCreated | updatedUserId | dateUpdated | completedByUserId | dateCompleted | deletedByUserId | dateDeleted)[],
>   fields[
>     portfolioColumns
>   ]?: (id | name | color)[],
>   fields[
>     portfolioCards
>   ]?: (id | columnId | projectId)[],
>   fields[
>     portfolioBoards
>   ]?: (id | name | color)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldProjects
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   featuresEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings | tasks)[],
>   excludeTagIds?: number[],
>   excludeProjectIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `projects` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   activities?: {
>   } | null,
>   companies?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldProjects?: {
>   } | null,
>   customfields?: {
>   } | null,
>   industries?: {
>   } | null,
>   portfolioBoards?: {
>   } | null,
>   portfolioCards?: {
>   } | null,
>   portfolioColumns?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectEmailDropboxes?: {
>   } | null,
>   projectTaskStats?: {
>   } | null,
>   projectUpdates?: {
>   } | null,
>   stages?: {
>   } | null,
>   tags?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   integrations?: {
>   } | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   permissions?: {
>   } | null,
>   prevCursor?: string | null,
>   projectProfitability?: {
>   } | null,
>   projectStats?: {
>     active?: number | null,
>     archived?: number | null,
>     complete?: number | null,
>     count?: number | null,
>     current?: number | null,
>     hasEvents?: boolean | null,
>     late?: number | null,
>     noDate?: number | null,
>     starred?: number | null,
>     today?: number | null,
>     upcoming?: number | null
>   } | null,
>   projects?: {
>     active?: number | null,
>     archived?: number | null,
>     completed?: number | null,
>     current?: number | null,
>     late?: number | null,
>     total?: number | null,
>     upcoming?: number | null
>   } | null,
>   stats?: {
>     billing?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     events?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     milestones?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     tasks?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null,
>   user?: {
>     hasProjects?: boolean | null
>   } | null
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     activePages?: {
>       billing?: boolean | null,
>       board?: boolean | null,
>       comments?: boolean | null,
>       files?: boolean | null,
>       finance?: boolean | null,
>       forms?: boolean | null,
>       gantt?: boolean | null,
>       links?: boolean | null,
>       list?: boolean | null,
>       messages?: boolean | null,
>       milestones?: boolean | null,
>       notebooks?: boolean | null,
>       proofs?: boolean | null,
>       riskRegister?: boolean | null,
>       schedule?: boolean | null,
>       table?: boolean | null,
>       tasks?: boolean | null,
>       tickets?: boolean | null,
>       time?: boolean | null,
>       timeline?: boolean | null
>     } | null,
>     allowNotifyAnyone?: boolean | null,
>     announcement?: string | null,
>     archivedAt?: string | null,
>     archivedBy?: number | null,
>     budgetCount?: number | null,
>     category?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     categoryId?: number | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     customFieldValueIds?: (number | null)[] | null,
>     customfieldValues?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     defaultPrivacy?: string | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     directFileUploadsEnabled?: boolean | null,
>     endAt?: string | null,
>     endDate?: string | null,
>     financialBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     financialBudgetId?: number | null,
>     harvestTimersEnabled?: boolean | null,
>     id?: number | null,
>     integrations?: {
>       googleDrive?: {
>         access?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       oneDriveBusiness?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       sharepoint?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       xero?: {
>         baseCurrency?: string | null,
>         connected?: boolean | null,
>         countryCode?: string | null,
>         enabled?: boolean | null,
>         organisation?: string | null
>       } | null
>     } | null,
>     isBillable?: boolean | null,
>     isOnBoardingProject?: boolean | null,
>     isProjectAdmin?: boolean | null,
>     isSampleProject?: boolean | null,
>     isStarred?: boolean | null,
>     lastWorkedOn?: string | null,
>     latestActivity?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     logo?: string | null,
>     logoColor?: string | null,
>     logoIcon?: string | null,
>     minMaxAvailableDates?: {
>       deadlinesFound?: boolean | null,
>       maxEndDate?: string | null,
>       minStartDate?: string | null,
>       suggestedEndDate?: string | null,
>       suggestedStartDate?: string | null
>     } | null,
>     name?: string | null,
>     notifyCommentIncludeCreator?: boolean | null,
>     notifyEveryone?: boolean | null,
>     notifyTaskAssignee?: boolean | null,
>     overviewStartPage?: string | null,
>     ownedBy?: number | null,
>     ownerId?: number | null,
>     portfolioCards?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     privacyEnabled?: boolean | null,
>     projectNumber?: string | null,
>     projectNumberCounter?: number | null,
>     projectOwner?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectOwnerId?: number | null,
>     replyByEmailEnabled?: boolean | null,
>     showAnnouncement?: boolean | null,
>     skipWeekends?: boolean | null,
>     startAt?: string | null,
>     startDate?: string | null,
>     startPage?: string | null,
>     status?: string | null,
>     subStatus?: string | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasksStartPage?: string | null,
>     timeBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timeBudgetId?: number | null,
>     timelogRequiresTask?: boolean | null,
>     type?: string | null,
>     update?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updateId?: number | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     workflowIds?: (number | null)[] | null,
>     workflows?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

### listStarred

`projects.listStarred`

List the projects the current user has starred.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.listStarred({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   timeMode?: timelogs | estimated,
>   searchTerm?: string,
>   reportType?: project | health,
>   reportTimezone?: string,
>   reportFormat?: csv | html | pdf | xls | xlsx | google-sheets,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: creatorname | companyname | datecreated | startdate | duedate | lastactivity | name | namecaseinsensitive | ownercompany | ownername | health | taskcompletion | budgetused | starred | starredcompanyname | starredfirst | mobilespecial | lastworkedon | categoryname | customfield | status | id | projectnumber,
>   notCompletedBefore?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   userId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   minBudgetCapacityUsedPercent?: number,
>   maxBudgetCapacityUsedPercent?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchCompanies?: boolean,
>   searchByLetter?: boolean,
>   searchBudgets?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyProjectsWithExplicitMembership?: boolean,
>   onlyProjectsWithAdminAccess?: boolean,
>   onlyProjectsThatCanLogTime?: boolean,
>   onlyProjectsThatCanAddTasks?: boolean,
>   onlyArchivedProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTabSystemStatus?: boolean,
>   includeSubCategories?: boolean,
>   includeStats?: boolean,
>   includeProjectUserInfo?: boolean,
>   includeProjectProfitability?: boolean,
>   includeProjectDates?: boolean,
>   includeCustomFields?: boolean,
>   includeCounts?: boolean,
>   includeCompletedStatus?: boolean,
>   includeArchivedProjects?: boolean,
>   hideObservedProjects?: boolean,
>   alwaysIncludeFiltering?: boolean,
>   usersWithExplicitMembershipIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | inactive | archived | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectNumbers?: string[],
>   projectNumberCounters?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projectOwners | projectUpdates | companies | companies.countries | companies.industries | companies.currencies | projectCategories | portfolioCards | portfolioBoards | portfolioColumns | tags | customfields | customfieldProjects | projectBudgets | activities.latest | users | createdBy | updatedBy | completedBy | deletedBy | archivedBy | projectEmailDropboxes | workflows | workflows.stages | projecttaskstats)[],
>   filter?: any[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[],
>   fields[
>     projectBudgets
>   ]?: (id | projectId | type | status | capacityUsed | capacity | originatorBudgetId | isRepeating | repeatPeriod | repeatUnit | repeatsRemaining | sequenceNumber | startDateTime | endDateTime | currencyCode | timelogType | expenseType | defaultRate | notificationIds | createdByUserId | dateCreated | updatedUserId | dateUpdated | completedByUserId | dateCompleted | deletedByUserId | dateDeleted)[],
>   fields[
>     portfolioColumns
>   ]?: (id | name | color)[],
>   fields[
>     portfolioCards
>   ]?: (id | columnId | projectId)[],
>   fields[
>     portfolioBoards
>   ]?: (id | name | color)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldProjects
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   featuresEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings | tasks)[],
>   excludeTagIds?: number[],
>   excludeProjectIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `projects` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   activities?: {
>   } | null,
>   companies?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldProjects?: {
>   } | null,
>   customfields?: {
>   } | null,
>   industries?: {
>   } | null,
>   portfolioBoards?: {
>   } | null,
>   portfolioCards?: {
>   } | null,
>   portfolioColumns?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectEmailDropboxes?: {
>   } | null,
>   projectTaskStats?: {
>   } | null,
>   projectUpdates?: {
>   } | null,
>   stages?: {
>   } | null,
>   tags?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   integrations?: {
>   } | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   permissions?: {
>   } | null,
>   prevCursor?: string | null,
>   projectProfitability?: {
>   } | null,
>   projectStats?: {
>     active?: number | null,
>     archived?: number | null,
>     complete?: number | null,
>     count?: number | null,
>     current?: number | null,
>     hasEvents?: boolean | null,
>     late?: number | null,
>     noDate?: number | null,
>     starred?: number | null,
>     today?: number | null,
>     upcoming?: number | null
>   } | null,
>   projects?: {
>     active?: number | null,
>     archived?: number | null,
>     completed?: number | null,
>     current?: number | null,
>     late?: number | null,
>     total?: number | null,
>     upcoming?: number | null
>   } | null,
>   stats?: {
>     billing?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     events?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     milestones?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     tasks?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null,
>   user?: {
>     hasProjects?: boolean | null
>   } | null
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     activePages?: {
>       billing?: boolean | null,
>       board?: boolean | null,
>       comments?: boolean | null,
>       files?: boolean | null,
>       finance?: boolean | null,
>       forms?: boolean | null,
>       gantt?: boolean | null,
>       links?: boolean | null,
>       list?: boolean | null,
>       messages?: boolean | null,
>       milestones?: boolean | null,
>       notebooks?: boolean | null,
>       proofs?: boolean | null,
>       riskRegister?: boolean | null,
>       schedule?: boolean | null,
>       table?: boolean | null,
>       tasks?: boolean | null,
>       tickets?: boolean | null,
>       time?: boolean | null,
>       timeline?: boolean | null
>     } | null,
>     allowNotifyAnyone?: boolean | null,
>     announcement?: string | null,
>     archivedAt?: string | null,
>     archivedBy?: number | null,
>     budgetCount?: number | null,
>     category?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     categoryId?: number | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     customFieldValueIds?: (number | null)[] | null,
>     customfieldValues?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     defaultPrivacy?: string | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     directFileUploadsEnabled?: boolean | null,
>     endAt?: string | null,
>     endDate?: string | null,
>     financialBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     financialBudgetId?: number | null,
>     harvestTimersEnabled?: boolean | null,
>     id?: number | null,
>     integrations?: {
>       googleDrive?: {
>         access?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       oneDriveBusiness?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       sharepoint?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       xero?: {
>         baseCurrency?: string | null,
>         connected?: boolean | null,
>         countryCode?: string | null,
>         enabled?: boolean | null,
>         organisation?: string | null
>       } | null
>     } | null,
>     isBillable?: boolean | null,
>     isOnBoardingProject?: boolean | null,
>     isProjectAdmin?: boolean | null,
>     isSampleProject?: boolean | null,
>     isStarred?: boolean | null,
>     lastWorkedOn?: string | null,
>     latestActivity?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     logo?: string | null,
>     logoColor?: string | null,
>     logoIcon?: string | null,
>     minMaxAvailableDates?: {
>       deadlinesFound?: boolean | null,
>       maxEndDate?: string | null,
>       minStartDate?: string | null,
>       suggestedEndDate?: string | null,
>       suggestedStartDate?: string | null
>     } | null,
>     name?: string | null,
>     notifyCommentIncludeCreator?: boolean | null,
>     notifyEveryone?: boolean | null,
>     notifyTaskAssignee?: boolean | null,
>     overviewStartPage?: string | null,
>     ownedBy?: number | null,
>     ownerId?: number | null,
>     portfolioCards?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     privacyEnabled?: boolean | null,
>     projectNumber?: string | null,
>     projectNumberCounter?: number | null,
>     projectOwner?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectOwnerId?: number | null,
>     replyByEmailEnabled?: boolean | null,
>     showAnnouncement?: boolean | null,
>     skipWeekends?: boolean | null,
>     startAt?: string | null,
>     startDate?: string | null,
>     startPage?: string | null,
>     status?: string | null,
>     subStatus?: string | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasksStartPage?: string | null,
>     timeBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timeBudgetId?: number | null,
>     timelogRequiresTask?: boolean | null,
>     type?: string | null,
>     update?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updateId?: number | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     workflowIds?: (number | null)[] | null,
>     workflows?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

### listTaskPredecessors

`projects.listTaskPredecessors`

List every task dependency (predecessor) in a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projects.listTaskPredecessors({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   includeDependencies?: boolean,
>   onlyDependencies?: boolean,
>   onlyBasicFields?: boolean,
>   onlyActionable?: boolean,
>   dataSet?: string,
>   page?: string,
>   pageSize?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### setRates

`projects.setRates`

Set a project's billable rates.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.setRates({
	path: { id: '1470497' },
	body: {
		rates: { project-default: 12000 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   rates?: {
>     users?: {
>       12345?: {
>         rate?: number
>       },
>       12346?: {
>         rate?: number
>       }
>     },
>     project-default?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### star

`projects.star`

Star a project for the current user.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.star({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`projects.update`

Update a project's name, dates, owner, category or settings.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projects.update({
	path: { id: '1470497' },
	body: {
		project: { description: 'Q1 site rebuild, phase 2' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   project?: {
>     name?: string,
>     use-tasks?: boolean,
>     use-milestones?: boolean,
>     use-messages?: boolean,
>     use-files?: boolean,
>     use-time?: boolean,
>     use-notebook?: boolean,
>     use-riskregister?: boolean,
>     use-links?: boolean,
>     use-billing?: boolean,
>     use-comments?: boolean,
>     category-id?: number,
>     start-date?: string,
>     end-date?: string,
>     tagIds?: string,
>     onboarding?: boolean,
>     templateDateTargetDefault?: string,
>     grant-access-to?: string,
>     private?: boolean,
>     customFields?: {
>       customFieldId?: number,
>       value?: string
>     }[],
>     people?: string,
>     projectOwnerId?: string,
>     companyId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Project Templates

### create

`projectTemplates.create`

Create a project template.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.projectTemplates.create({
	body: {
		project: {
			name: 'Client onboarding template',
			templateDateTargetDefault: 'start',
			use-tasks: true,
			use-milestones: true,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   project?: {
>     name?: string,
>     use-tasks?: boolean,
>     use-milestones?: boolean,
>     use-messages?: boolean,
>     use-files?: boolean,
>     use-time?: boolean,
>     use-notebook?: boolean,
>     use-riskregister?: boolean,
>     use-links?: boolean,
>     use-billing?: boolean,
>     use-comments?: boolean,
>     category-id?: number,
>     tags?: string,
>     templateDateTargetDefault: string,
>     people?: string,
>     projectOwnerId?: string,
>     companyId?: number,
>     grant-access-to?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`projectTemplates.get`

Get one project template.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectTemplates.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   timeMode?: timelogs | estimated,
>   searchTerm?: string,
>   reportType?: project | health,
>   reportTimezone?: string,
>   reportFormat?: csv | html | pdf | xls | xlsx | google-sheets,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: creatorname | companyname | datecreated | startdate | duedate | lastactivity | name | namecaseinsensitive | ownercompany | ownername | health | taskcompletion | budgetused | starred | starredcompanyname | starredfirst | mobilespecial | lastworkedon | categoryname | customfield | status | id | projectnumber,
>   notCompletedBefore?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   userId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   minBudgetCapacityUsedPercent?: number,
>   maxBudgetCapacityUsedPercent?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchCompanies?: boolean,
>   searchByLetter?: boolean,
>   searchBudgets?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyProjectsWithExplicitMembership?: boolean,
>   onlyProjectsWithAdminAccess?: boolean,
>   onlyProjectsThatCanLogTime?: boolean,
>   onlyProjectsThatCanAddTasks?: boolean,
>   onlyArchivedProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTabSystemStatus?: boolean,
>   includeSubCategories?: boolean,
>   includeStats?: boolean,
>   includeProjectUserInfo?: boolean,
>   includeProjectProfitability?: boolean,
>   includeProjectDates?: boolean,
>   includeCustomFields?: boolean,
>   includeCounts?: boolean,
>   includeCompletedStatus?: boolean,
>   includeArchivedProjects?: boolean,
>   hideObservedProjects?: boolean,
>   alwaysIncludeFiltering?: boolean,
>   usersWithExplicitMembershipIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | inactive | archived | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectNumbers?: string[],
>   projectNumberCounters?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projectOwners | projectUpdates | companies | companies.countries | companies.industries | companies.currencies | projectCategories | portfolioCards | portfolioBoards | portfolioColumns | tags | customfields | customfieldProjects | projectBudgets | activities.latest | users | createdBy | updatedBy | completedBy | deletedBy | archivedBy | projectEmailDropboxes | workflows | workflows.stages | projecttaskstats)[],
>   filter?: any[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[],
>   fields[
>     projectBudgets
>   ]?: (id | projectId | type | status | capacityUsed | capacity | originatorBudgetId | isRepeating | repeatPeriod | repeatUnit | repeatsRemaining | sequenceNumber | startDateTime | endDateTime | currencyCode | timelogType | expenseType | defaultRate | notificationIds | createdByUserId | dateCreated | updatedUserId | dateUpdated | completedByUserId | dateCompleted | deletedByUserId | dateDeleted)[],
>   fields[
>     portfolioColumns
>   ]?: (id | name | color)[],
>   fields[
>     portfolioCards
>   ]?: (id | columnId | projectId)[],
>   fields[
>     portfolioBoards
>   ]?: (id | name | color)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldProjects
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   featuresEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings | tasks)[],
>   excludeTagIds?: number[],
>   excludeProjectIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `project` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   activities?: {
>   } | null,
>   companies?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldProjects?: {
>   } | null,
>   customfields?: {
>   } | null,
>   industries?: {
>   } | null,
>   portfolioBoards?: {
>   } | null,
>   portfolioCards?: {
>   } | null,
>   portfolioColumns?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectEmailDropboxes?: {
>   } | null,
>   projectTaskStats?: {
>   } | null,
>   projectUpdates?: {
>   } | null,
>   stages?: {
>   } | null,
>   tags?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   integrations?: {
>   } | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   permissions?: {
>   } | null,
>   prevCursor?: string | null,
>   projectProfitability?: {
>   } | null,
>   projectStats?: {
>     active?: number | null,
>     archived?: number | null,
>     complete?: number | null,
>     count?: number | null,
>     current?: number | null,
>     hasEvents?: boolean | null,
>     late?: number | null,
>     noDate?: number | null,
>     starred?: number | null,
>     today?: number | null,
>     upcoming?: number | null
>   } | null,
>   projects?: {
>     active?: number | null,
>     archived?: number | null,
>     completed?: number | null,
>     current?: number | null,
>     late?: number | null,
>     total?: number | null,
>     upcoming?: number | null
>   } | null,
>   stats?: {
>     billing?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     events?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     milestones?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     tasks?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null,
>   user?: {
>     hasProjects?: boolean | null
>   } | null
> } | null
> ```

> [accordion] project full type
>
> ```ts theme={null}
> {
>   activePages?: {
>     billing?: boolean | null,
>     board?: boolean | null,
>     comments?: boolean | null,
>     files?: boolean | null,
>     finance?: boolean | null,
>     forms?: boolean | null,
>     gantt?: boolean | null,
>     links?: boolean | null,
>     list?: boolean | null,
>     messages?: boolean | null,
>     milestones?: boolean | null,
>     notebooks?: boolean | null,
>     proofs?: boolean | null,
>     riskRegister?: boolean | null,
>     schedule?: boolean | null,
>     table?: boolean | null,
>     tasks?: boolean | null,
>     tickets?: boolean | null,
>     time?: boolean | null,
>     timeline?: boolean | null
>   } | null,
>   allowNotifyAnyone?: boolean | null,
>   announcement?: string | null,
>   archivedAt?: string | null,
>   archivedBy?: number | null,
>   budgetCount?: number | null,
>   category?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   categoryId?: number | null,
>   company?: {
>     id?: number | null,
>     meta?: {
>       name?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   companyId?: number | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   customFieldValueIds?: (number | null)[] | null,
>   customfieldValues?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   defaultPrivacy?: string | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   directFileUploadsEnabled?: boolean | null,
>   endAt?: string | null,
>   endDate?: string | null,
>   financialBudget?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   financialBudgetId?: number | null,
>   harvestTimersEnabled?: boolean | null,
>   id?: number | null,
>   integrations?: {
>     googleDrive?: {
>       access?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     oneDriveBusiness?: {
>       account?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     sharepoint?: {
>       account?: string | null,
>       enabled?: boolean | null,
>       folder?: string | null,
>       folderName?: string | null
>     } | null,
>     xero?: {
>       baseCurrency?: string | null,
>       connected?: boolean | null,
>       countryCode?: string | null,
>       enabled?: boolean | null,
>       organisation?: string | null
>     } | null
>   } | null,
>   isBillable?: boolean | null,
>   isOnBoardingProject?: boolean | null,
>   isProjectAdmin?: boolean | null,
>   isSampleProject?: boolean | null,
>   isStarred?: boolean | null,
>   lastWorkedOn?: string | null,
>   latestActivity?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   logo?: string | null,
>   logoColor?: string | null,
>   logoIcon?: string | null,
>   minMaxAvailableDates?: {
>     deadlinesFound?: boolean | null,
>     maxEndDate?: string | null,
>     minStartDate?: string | null,
>     suggestedEndDate?: string | null,
>     suggestedStartDate?: string | null
>   } | null,
>   name?: string | null,
>   notifyCommentIncludeCreator?: boolean | null,
>   notifyEveryone?: boolean | null,
>   notifyTaskAssignee?: boolean | null,
>   overviewStartPage?: string | null,
>   ownedBy?: number | null,
>   ownerId?: number | null,
>   portfolioCards?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   privacyEnabled?: boolean | null,
>   projectNumber?: string | null,
>   projectNumberCounter?: number | null,
>   projectOwner?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectOwnerId?: number | null,
>   replyByEmailEnabled?: boolean | null,
>   showAnnouncement?: boolean | null,
>   skipWeekends?: boolean | null,
>   startAt?: string | null,
>   startDate?: string | null,
>   startPage?: string | null,
>   status?: string | null,
>   subStatus?: string | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasksStartPage?: string | null,
>   timeBudget?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeBudgetId?: number | null,
>   timelogRequiresTask?: boolean | null,
>   type?: string | null,
>   update?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updateId?: number | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   users?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   workflowIds?: (number | null)[] | null,
>   workflows?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null
> } | null
> ```

***

### list

`projectTemplates.list`

List project templates.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectTemplates.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   timeMode?: timelogs | estimated,
>   searchTerm?: string,
>   reportType?: project | health,
>   reportTimezone?: string,
>   reportFormat?: csv | html | pdf | xls | xlsx | google-sheets,
>   projectType?: all | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: creatorname | companyname | datecreated | startdate | duedate | lastactivity | name | namecaseinsensitive | ownercompany | ownername | health | taskcompletion | budgetused | starred | starredcompanyname | starredfirst | mobilespecial | lastworkedon | categoryname | customfield | status | id | projectnumber,
>   notCompletedBefore?: string,
>   minLastActivityDate?: string,
>   maxLastActivityDate?: string,
>   userId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   minBudgetCapacityUsedPercent?: number,
>   maxBudgetCapacityUsedPercent?: number,
>   useFormulaFields?: boolean,
>   skipCounts?: boolean,
>   searchCompanies?: boolean,
>   searchByLetter?: boolean,
>   searchBudgets?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyProjectsWithExplicitMembership?: boolean,
>   onlyProjectsWithAdminAccess?: boolean,
>   onlyProjectsThatCanLogTime?: boolean,
>   onlyProjectsThatCanAddTasks?: boolean,
>   onlyArchivedProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTabSystemStatus?: boolean,
>   includeSubCategories?: boolean,
>   includeStats?: boolean,
>   includeProjectUserInfo?: boolean,
>   includeProjectProfitability?: boolean,
>   includeProjectDates?: boolean,
>   includeCustomFields?: boolean,
>   includeCounts?: boolean,
>   includeCompletedStatus?: boolean,
>   includeArchivedProjects?: boolean,
>   hideObservedProjects?: boolean,
>   alwaysIncludeFiltering?: boolean,
>   usersWithExplicitMembershipIds?: number[],
>   teamIds?: number[],
>   selectedColumns?: string[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | inactive | archived | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectNumbers?: string[],
>   projectNumberCounters?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projectOwners | projectUpdates | companies | companies.countries | companies.industries | companies.currencies | projectCategories | portfolioCards | portfolioBoards | portfolioColumns | tags | customfields | customfieldProjects | projectBudgets | activities.latest | users | createdBy | updatedBy | completedBy | deletedBy | archivedBy | projectEmailDropboxes | workflows | workflows.stages | projecttaskstats)[],
>   filter?: any[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[],
>   fields[
>     projectBudgets
>   ]?: (id | projectId | type | status | capacityUsed | capacity | originatorBudgetId | isRepeating | repeatPeriod | repeatUnit | repeatsRemaining | sequenceNumber | startDateTime | endDateTime | currencyCode | timelogType | expenseType | defaultRate | notificationIds | createdByUserId | dateCreated | updatedUserId | dateUpdated | completedByUserId | dateCompleted | deletedByUserId | dateDeleted)[],
>   fields[
>     portfolioColumns
>   ]?: (id | name | color)[],
>   fields[
>     portfolioCards
>   ]?: (id | columnId | projectId)[],
>   fields[
>     portfolioBoards
>   ]?: (id | name | color)[],
>   fields[
>     industries
>   ]?: string[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldProjects
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     countries
>   ]?: string[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   featuresEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings | tasks)[],
>   excludeTagIds?: number[],
>   excludeProjectIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `projects` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   activities?: {
>   } | null,
>   companies?: {
>   } | null,
>   countries?: {
>   } | null,
>   currencies?: {
>   } | null,
>   customfieldProjects?: {
>   } | null,
>   customfields?: {
>   } | null,
>   industries?: {
>   } | null,
>   portfolioBoards?: {
>   } | null,
>   portfolioCards?: {
>   } | null,
>   portfolioColumns?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectEmailDropboxes?: {
>   } | null,
>   projectTaskStats?: {
>   } | null,
>   projectUpdates?: {
>   } | null,
>   stages?: {
>   } | null,
>   tags?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   integrations?: {
>   } | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   permissions?: {
>   } | null,
>   prevCursor?: string | null,
>   projectProfitability?: {
>   } | null,
>   projectStats?: {
>     active?: number | null,
>     archived?: number | null,
>     complete?: number | null,
>     count?: number | null,
>     current?: number | null,
>     hasEvents?: boolean | null,
>     late?: number | null,
>     noDate?: number | null,
>     starred?: number | null,
>     today?: number | null,
>     upcoming?: number | null
>   } | null,
>   projects?: {
>     active?: number | null,
>     archived?: number | null,
>     completed?: number | null,
>     current?: number | null,
>     late?: number | null,
>     total?: number | null,
>     upcoming?: number | null
>   } | null,
>   stats?: {
>     billing?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     events?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     milestones?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null,
>     tasks?: {
>       active?: number | null,
>       archived?: number | null,
>       complete?: number | null,
>       count?: number | null,
>       current?: number | null,
>       hasEvents?: boolean | null,
>       late?: number | null,
>       noDate?: number | null,
>       starred?: number | null,
>       today?: number | null,
>       upcoming?: number | null
>     } | null
>   } | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null,
>   user?: {
>     hasProjects?: boolean | null
>   } | null
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     activePages?: {
>       billing?: boolean | null,
>       board?: boolean | null,
>       comments?: boolean | null,
>       files?: boolean | null,
>       finance?: boolean | null,
>       forms?: boolean | null,
>       gantt?: boolean | null,
>       links?: boolean | null,
>       list?: boolean | null,
>       messages?: boolean | null,
>       milestones?: boolean | null,
>       notebooks?: boolean | null,
>       proofs?: boolean | null,
>       riskRegister?: boolean | null,
>       schedule?: boolean | null,
>       table?: boolean | null,
>       tasks?: boolean | null,
>       tickets?: boolean | null,
>       time?: boolean | null,
>       timeline?: boolean | null
>     } | null,
>     allowNotifyAnyone?: boolean | null,
>     announcement?: string | null,
>     archivedAt?: string | null,
>     archivedBy?: number | null,
>     budgetCount?: number | null,
>     category?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     categoryId?: number | null,
>     company?: {
>       id?: number | null,
>       meta?: {
>         name?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     companyId?: number | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     customFieldValueIds?: (number | null)[] | null,
>     customfieldValues?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     defaultPrivacy?: string | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     directFileUploadsEnabled?: boolean | null,
>     endAt?: string | null,
>     endDate?: string | null,
>     financialBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     financialBudgetId?: number | null,
>     harvestTimersEnabled?: boolean | null,
>     id?: number | null,
>     integrations?: {
>       googleDrive?: {
>         access?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       oneDriveBusiness?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       sharepoint?: {
>         account?: string | null,
>         enabled?: boolean | null,
>         folder?: string | null,
>         folderName?: string | null
>       } | null,
>       xero?: {
>         baseCurrency?: string | null,
>         connected?: boolean | null,
>         countryCode?: string | null,
>         enabled?: boolean | null,
>         organisation?: string | null
>       } | null
>     } | null,
>     isBillable?: boolean | null,
>     isOnBoardingProject?: boolean | null,
>     isProjectAdmin?: boolean | null,
>     isSampleProject?: boolean | null,
>     isStarred?: boolean | null,
>     lastWorkedOn?: string | null,
>     latestActivity?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     logo?: string | null,
>     logoColor?: string | null,
>     logoIcon?: string | null,
>     minMaxAvailableDates?: {
>       deadlinesFound?: boolean | null,
>       maxEndDate?: string | null,
>       minStartDate?: string | null,
>       suggestedEndDate?: string | null,
>       suggestedStartDate?: string | null
>     } | null,
>     name?: string | null,
>     notifyCommentIncludeCreator?: boolean | null,
>     notifyEveryone?: boolean | null,
>     notifyTaskAssignee?: boolean | null,
>     overviewStartPage?: string | null,
>     ownedBy?: number | null,
>     ownerId?: number | null,
>     portfolioCards?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     privacyEnabled?: boolean | null,
>     projectNumber?: string | null,
>     projectNumberCounter?: number | null,
>     projectOwner?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectOwnerId?: number | null,
>     replyByEmailEnabled?: boolean | null,
>     showAnnouncement?: boolean | null,
>     skipWeekends?: boolean | null,
>     startAt?: string | null,
>     startDate?: string | null,
>     startPage?: string | null,
>     status?: string | null,
>     subStatus?: string | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasksStartPage?: string | null,
>     timeBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timeBudgetId?: number | null,
>     timelogRequiresTask?: boolean | null,
>     type?: string | null,
>     update?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updateId?: number | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     users?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     workflowIds?: (number | null)[] | null,
>     workflows?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

### listRequiredCustomFields

`projectTemplates.listRequiredCustomFields`

List the custom fields a template requires when a project is made from it.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectTemplates.listRequiredCustomFields({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `customfields` | `object[] \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |

> [accordion] customfields full type
>
> ```ts theme={null}
> (
>   {
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserId?: number | null,
>     currencyCode?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     deletedByUserId?: number | null,
>     entity?: string | null,
>     formula?: string | null,
>     groupId?: number | null,
>     id?: number | null,
>     isPrivate?: boolean | null,
>     name?: string | null,
>     options?: {
>       choices?: (
>         {
>           color?: string | null,
>           value?: string | null
>         } | null
>       )[] | null,
>       color?: string | null,
>       decimals?: number | null,
>       icon?: string | null
>     } | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     required?: boolean | null,
>     type?: string | null,
>     unitId?: number | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     updatedByUserId?: number | null,
>     visibilities?: (string | null)[] | null
>   } | null
> )[] | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

***

## Project Updates

### create

`projectUpdates.create`

Post a status update on a project. Notifies the people in notifyIds.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectUpdates.create({
	path: { projectId: '1470497' },
	body: {
		update: { text: 'Design signed off, build starts Monday.', health: '2' },
		notifyIds: '',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   update?: {
>     text?: string,
>     health?: string
>   },
>   notifyIds?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `updateId` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`projectUpdates.delete`

Delete a project update.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectUpdates.delete({
	path: { updateId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   updateId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `updateId` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### list

`projectUpdates.list`

List project status updates. Filter with projectIds.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.projectUpdates.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   projectStatus?: string,
>   orderMode?: asc | desc,
>   orderBy?: date | color | health | project | user | id,
>   createdAfter?: string,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   reactions?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   includeArchivedProjects?: boolean,
>   emoji?: boolean,
>   activeOnly?: boolean,
>   projectTagIds?: number[],
>   projectStatuses?: string[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: number[],
>   projectHealth?: number[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | createdBy | deletedBy | likes.users)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectUpdates
>   ]?: (id | projectId | text | isActive | health | color | dateCreated | deleted | deletedDate | numLikes | reactions)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `projectUpdates` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] projectUpdates full type
>
> ```ts theme={null}
> (
>   {
>     color?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     health?: number | null,
>     healthLabel?: string | null,
>     id?: number | null,
>     isActive?: boolean | null,
>     likeFromUserIDs?: (number | null)[] | null,
>     likeFromUsers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     reactions?: {
>       counts?: {
>         dislike?: number | null,
>         frown?: number | null,
>         heart?: number | null,
>         joy?: number | null,
>         like?: number | null
>       } | null,
>       extendedReactions?: (
>         {
>           count?: number | null,
>           emoji?: string | null,
>           mine?: boolean | null
>         } | null
>       )[] | null,
>       mine?: (string | null)[] | null
>     } | null,
>     text?: string | null,
>     updatedAt?: string | null
>   } | null
> )[] | null
> ```

***

### request

`projectUpdates.request`

Ask the project owner for a status update. Notifies the owner.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectUpdates.request({
	path: { projectId: '1470497' },
	body: { userId: '753865', content: 'Could you post a status update before Friday\'s review?' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   userId?: string,
>   content?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`projectUpdates.update`

Edit a project update.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.projectUpdates.update({
	path: { updateId: '1' },
	body: {
		update: { text: 'Design signed off, build starts Tuesday.' },
		notifyIds: '',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   updateId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   update?: {
>     text?: string
>   },
>   notifyIds?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `updateId` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Statuses

### create

`statuses.create`

Set a person's status.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.statuses.create({
	path: { id: '753865' },
	body: {
		userStatus: { status: 'Out until Monday', notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   userStatus?: {
>     status?: string,
>     notify?: boolean,
>     notifyIds?: {
>     }[]
>   }
> }
> ```

**Output:** *empty object*

***

### delete

`statuses.delete`

Delete a status by id.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.statuses.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### getForPerson

`statuses.getForPerson`

Get a person's status.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.statuses.getForPerson({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `userStatus` | `object \| null` | No | — |

> [accordion] userStatus full type
>
> ```ts theme={null}
> {
>   first-name?: string | number | boolean | null,
>   avatar-url?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   status?: string | number | boolean | null,
>   last-name?: string | number | boolean | null
> } | null
> ```

***

### getMine

`statuses.getMine`

Get the current user's status.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.statuses.getMine({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `userStatus` | `object \| null` | No | — |

> [accordion] userStatus full type
>
> ```ts theme={null}
> {
>   first-name?: string | number | boolean | null,
>   avatar-url?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   status?: string | number | boolean | null,
>   last-name?: string | number | boolean | null
> } | null
> ```

***

### list

`statuses.list`

List everyone's current status.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.statuses.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   searchTerm?: string,
>   teamId?: number,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showEveryone?: boolean,
>   showDeleted?: boolean,
>   includeSubteams?: boolean,
>   include?: (statuses | users | userevents)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     statuses
>   ]?: (id | userId | emoji | text | dateTime | ipAddress | dateLastUpdated)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `userStatuses` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   statuses?: {
>   } | null,
>   userEvents?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] userStatuses full type
>
> ```ts theme={null}
> (
>   {
>     id?: number | null,
>     reset?: boolean | null,
>     status?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     statusId?: number | null,
>     updatedAt?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null
>   } | null
> )[] | null
> ```

***

### timeline

`statuses.timeline`

The people status timeline.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.statuses.timeline({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   searchTerm?: string,
>   teamId?: number,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   includeSubteams?: boolean,
>   include?: (users | userevents)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     statuses
>   ]?: (id | userId | emoji | text | dateTime | ipAddress | dateLastUpdated)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `statuses` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   userEvents?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] statuses full type
>
> ```ts theme={null}
> (
>   {
>     dateLastUpdated?: string | null,
>     dateTime?: string | null,
>     deleted?: boolean | null,
>     emoji?: string | null,
>     id?: number | null,
>     ipAddress?: string | null,
>     text?: string | null,
>     updatedAt?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null
>   } | null
> )[] | null
> ```

***

### update

`statuses.update`

Update a status by id.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.statuses.update({
	path: { id: '1' },
	body: {
		userstatus: { status: 'Back Tuesday' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   userstatus?: {
>     status?: string,
>     notify?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Tasklists

### copy

`tasklists.copy`

Copy a task list, within its project or to another.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasklists.copy({
	path: { id: '4073104' },
	body: { projectId: 1470498, includeCompletedTasks: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   projectId?: number,
>   includeCompletedTasks?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### create

`tasklists.create`

Create a task list in a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasklists.create({
	path: { id: '1470497' },
	body: {
		todo-list: { name: 'Launch', description: 'Everything for launch day' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   applyDefaultsToExistingTasks?: boolean,
>   todo-list?: {
>     new-task-defaults?: {
>       start-date-offset?: string,
>       due-date-offset?: string,
>       responsible-party-id?: string,
>       priority?: number,
>       priorityText?: string,
>       estimated-minutes?: number,
>       tags?: {
>         id?: number,
>         color?: string,
>         name?: string,
>         projectId?: number
>       }[],
>       column-id?: number,
>       reminders?: {
>         user-id?: number,
>         type?: string,
>         note?: string,
>         people-assigned?: boolean,
>         isRelative?: boolean,
>         relative-number-days?: number,
>         usingOffSetDueDate?: boolean,
>         time?: string
>       }[],
>       removeAllReminders?: boolean,
>       comment-follower-ids?: string,
>       change-follower-ids?: string,
>       grant-access-to?: string,
>       private?: boolean,
>       customFields?: {
>         customFieldId?: number,
>         value?: string
>       }[],
>       pendingFileAttachments?: {
>       }[]
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `TASKLISTID` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### delete

`tasklists.delete`

Delete a task list and its tasks.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.tasklists.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`tasklists.get`

Get one task list.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasklists.get({
	path: { tasklistId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   tasklistId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   searchTerm?: string,
>   projectType?: string,
>   orderMode?: asc | desc,
>   orderBy?: displayorder | name | status | createdat | updatedat | project | id,
>   projectBudgetId?: number,
>   pageSize?: number,
>   page?: number,
>   useFormulaFields?: boolean,
>   sortDefaultListFirst?: boolean,
>   sortActiveListsFirst?: boolean,
>   skipCounts?: boolean,
>   showPrivate?: boolean,
>   showDeleted?: boolean,
>   showCompleted?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   getEmptyLists?: boolean,
>   completedOnly?: boolean,
>   calculateDates?: boolean,
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   include?: (defaultTasks | defaultTasks.users | defaultTasks.teams | defaultTasks.reminders | defaultTasks.customfields | defaultTasks.companies | defaultTasks.jobRoles | defaultTasks.tags | defaultTasks.changeFollowers | defaultTasks.commentFollowers | defaultTasks.completeFollowers | defaultTasks.lockdowns | defaultTasks.lockdowns.users | defaultTasks.lockdowns.companies | defaultTasks.lockdowns.teams | createdBy | updatedBy | companies | projects | projects.permissions | projects.integrations | milestones | defaultCustomfields | defaultCustomfieldTasks | defaultColumns | defaultWorkflowStages | defaultWorkflows | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | tasklisttaskstats | tasklistBudgets | tasklistBudgets.notifications | tasklistBudgets.notifications.users | tasklistBudgets.notifications.teams | tasklistBudgets.notifications.companies)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `tasklist` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   defaultTaskReminders?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   notifications?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklistBudgets?: {
>   } | null,
>   tasklistTaskStats?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null,
>   workflowStages?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] tasklist full type
>
> ```ts theme={null}
> {
>   calculatedDueDate?: string | null,
>   calculatedStartDate?: string | null,
>   createdAt?: string | null,
>   defaultTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   defaultTaskId?: number | null,
>   displayOrder?: number | null,
>   icon?: string | null,
>   id?: number | null,
>   isBillable?: boolean | null,
>   isPinned?: boolean | null,
>   isPrivate?: boolean | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   lockdownId?: number | null,
>   milestone?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   milestoneId?: number | null,
>   name?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   status?: string | null,
>   tasklistBudget?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null
> } | null
> ```

***

### list

`tasklists.list`

List task lists. Filter with projectIds.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasklists.list({
	query: {
		projectIds: [1470497],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   searchTerm?: string,
>   projectType?: string,
>   orderMode?: asc | desc,
>   orderBy?: displayorder | name | status | createdat | updatedat | project | id,
>   projectBudgetId?: number,
>   pageSize?: number,
>   page?: number,
>   useFormulaFields?: boolean,
>   sortDefaultListFirst?: boolean,
>   sortActiveListsFirst?: boolean,
>   skipCounts?: boolean,
>   showPrivate?: boolean,
>   showDeleted?: boolean,
>   showCompleted?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   getEmptyLists?: boolean,
>   completedOnly?: boolean,
>   calculateDates?: boolean,
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   include?: (defaultTasks | defaultTasks.users | defaultTasks.teams | defaultTasks.reminders | defaultTasks.customfields | defaultTasks.companies | defaultTasks.jobRoles | defaultTasks.tags | defaultTasks.changeFollowers | defaultTasks.commentFollowers | defaultTasks.completeFollowers | defaultTasks.lockdowns | defaultTasks.lockdowns.users | defaultTasks.lockdowns.companies | defaultTasks.lockdowns.teams | createdBy | updatedBy | companies | projects | projects.permissions | projects.integrations | milestones | defaultCustomfields | defaultCustomfieldTasks | defaultColumns | defaultWorkflowStages | defaultWorkflows | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | tasklisttaskstats | tasklistBudgets | tasklistBudgets.notifications | tasklistBudgets.notifications.users | tasklistBudgets.notifications.teams | tasklistBudgets.notifications.companies)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `tasklists` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   defaultTaskReminders?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   notifications?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklistBudgets?: {
>   } | null,
>   tasklistTaskStats?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null,
>   workflowStages?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] tasklists full type
>
> ```ts theme={null}
> (
>   {
>     calculatedDueDate?: string | null,
>     calculatedStartDate?: string | null,
>     createdAt?: string | null,
>     defaultTask?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     defaultTaskId?: number | null,
>     displayOrder?: number | null,
>     icon?: string | null,
>     id?: number | null,
>     isBillable?: boolean | null,
>     isPinned?: boolean | null,
>     isPrivate?: boolean | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     lockdownId?: number | null,
>     milestone?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     milestoneId?: number | null,
>     name?: string | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     status?: string | null,
>     tasklistBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updatedAt?: string | null
>   } | null
> )[] | null
> ```

***

### listTemplates

`tasklists.listTemplates`

List task list templates.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasklists.listTemplates({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   searchTerm?: string,
>   projectType?: string,
>   orderMode?: asc | desc,
>   orderBy?: displayorder | name | status | createdat | updatedat | project | id,
>   projectBudgetId?: number,
>   pageSize?: number,
>   page?: number,
>   useFormulaFields?: boolean,
>   sortDefaultListFirst?: boolean,
>   sortActiveListsFirst?: boolean,
>   skipCounts?: boolean,
>   showPrivate?: boolean,
>   showDeleted?: boolean,
>   showCompleted?: boolean,
>   isReportDownload?: boolean,
>   includeTentativeProjects?: boolean,
>   includeArchivedProjects?: boolean,
>   getEmptyLists?: boolean,
>   completedOnly?: boolean,
>   calculateDates?: boolean,
>   projectIds?: number[],
>   projectCompanyIds?: number[],
>   include?: (defaultTasks | defaultTasks.users | defaultTasks.teams | defaultTasks.reminders | defaultTasks.customfields | defaultTasks.companies | defaultTasks.jobRoles | defaultTasks.tags | defaultTasks.changeFollowers | defaultTasks.commentFollowers | defaultTasks.completeFollowers | defaultTasks.lockdowns | defaultTasks.lockdowns.users | defaultTasks.lockdowns.companies | defaultTasks.lockdowns.teams | createdBy | updatedBy | companies | projects | projects.permissions | projects.integrations | milestones | defaultCustomfields | defaultCustomfieldTasks | defaultColumns | defaultWorkflowStages | defaultWorkflows | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | tasklisttaskstats | tasklistBudgets | tasklistBudgets.notifications | tasklistBudgets.notifications.users | tasklistBudgets.notifications.teams | tasklistBudgets.notifications.companies)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `tasklists` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   ProjectPermissions?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   defaultTaskReminders?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   notifications?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklistBudgets?: {
>   } | null,
>   tasklistTaskStats?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null,
>   workflowStages?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] tasklists full type
>
> ```ts theme={null}
> (
>   {
>     calculatedDueDate?: string | null,
>     calculatedStartDate?: string | null,
>     createdAt?: string | null,
>     defaultTask?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     defaultTaskId?: number | null,
>     displayOrder?: number | null,
>     icon?: string | null,
>     id?: number | null,
>     isBillable?: boolean | null,
>     isPinned?: boolean | null,
>     isPrivate?: boolean | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     lockdownId?: number | null,
>     milestone?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     milestoneId?: number | null,
>     name?: string | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     status?: string | null,
>     tasklistBudget?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updatedAt?: string | null
>   } | null
> )[] | null
> ```

***

### move

`tasklists.move`

Move a task list to another project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasklists.move({
	path: { id: '4073104' },
	body: { projectId: '1470498' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   projectId: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### reorder

`tasklists.reorder`

Reorder the task lists in a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasklists.reorder({
	path: { id: '1470497' },
	body: {
		todo-lists: [{
			todo-list: { id: '4073104' },
		}, {
			todo-list: { id: '4073105' },
		}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   todo-lists?: {
>     todo-list?: {
>       id?: string
>     }
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`tasklists.update`

Update a task list.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasklists.update({
	path: { id: '4073104' },
	body: {
		todo-list: { name: 'Launch week', description: 'Everything for launch day' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   applyDefaultsToExistingTasks?: boolean,
>   todo-list?: {
>     new-task-defaults?: {
>       start-date-offset?: string,
>       due-date-offset?: string,
>       responsible-party-id?: string,
>       priority?: number,
>       priorityText?: string,
>       estimated-minutes?: number,
>       tags?: {
>         id?: number,
>         color?: string,
>         name?: string,
>         projectId?: number
>       }[],
>       column-id?: number,
>       reminders?: {
>         user-id?: number,
>         type?: string,
>         note?: string,
>         people-assigned?: boolean,
>         isRelative?: boolean,
>         relative-number-days?: number,
>         usingOffSetDueDate?: boolean,
>         time?: string
>       }[],
>       removeAllReminders?: boolean,
>       comment-follower-ids?: string,
>       change-follower-ids?: string,
>       grant-access-to?: string,
>       private?: boolean,
>       customFields?: {
>         customFieldId?: number,
>         value?: string
>       }[],
>       pendingFileAttachments?: {
>       }[]
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

## Task Reminders

### create

`taskReminders.create`

Add a reminder to a task. Teamwork emails or messages the people it names when it fires.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.taskReminders.create({
	path: { taskId: 51453032 },
	body: {
		reminder: {
			remindAt: '2026-12-08T09:00:00Z',
			type: 'email',
			userIds: [753865],
			note: 'Check the draft',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   reminder?: {
>     isRelative?: boolean,
>     note?: string,
>     relativeNumberDays?: number,
>     remindAt?: string,
>     teamIds?: number[],
>     type?: string,
>     userIds?: number[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `reminders` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   users?: {
>   } | null
> } | null
> ```

> [accordion] reminders full type
>
> ```ts theme={null}
> (
>   {
>     createdAt?: string | null,
>     createdBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     id?: number | null,
>     isRelative?: boolean | null,
>     note?: string | null,
>     relativeNumberDays?: number | null,
>     remindAt?: string | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     type?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     wasSent?: boolean | null
>   } | null
> )[] | null
> ```

***

### delete

`taskReminders.delete`

Delete a task reminder.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.taskReminders.delete({
	path: { taskId: 1, reminderId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number,
>   reminderId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### list

`taskReminders.list`

List the reminders on a task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.taskReminders.list({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: (users | createdBy)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `reminders` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   users?: {
>   } | null
> } | null
> ```

> [accordion] reminders full type
>
> ```ts theme={null}
> (
>   {
>     createdAt?: string | null,
>     createdBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     id?: number | null,
>     isRelative?: boolean | null,
>     note?: string | null,
>     relativeNumberDays?: number | null,
>     remindAt?: string | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     type?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     wasSent?: boolean | null
>   } | null
> )[] | null
> ```

***

### update

`taskReminders.update`

Change a reminder's time, type or note. To change who gets it, delete it and add a new one.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.taskReminders.update({
	path: { taskId: 51453032, reminderId: 500772 },
	body: {
		reminder: { remindAt: '2026-12-09T09:00:00Z', type: 'email', note: 'Check the second draft' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number,
>   reminderId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   reminder?: {
>     isRelative?: boolean,
>     note?: string,
>     relativeNumberDays?: number,
>     remindAt?: string,
>     type?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `reminder` | `object \| null` | No | — |

> [accordion] reminder full type
>
> ```ts theme={null}
> {
>   createdAt?: string | null,
>   createdBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   id?: number | null,
>   isRelative?: boolean | null,
>   note?: string | null,
>   relativeNumberDays?: number | null,
>   remindAt?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   type?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   wasSent?: boolean | null
> } | null
> ```

***

## Tasks

### complete

`tasks.complete`

Mark a task complete.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.complete({
	path: { id: '51453032' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### copy

`tasks.copy`

Copy a task to another project or task list.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.copy({
	path: { taskId: '51453032' },
	body: { projectId: 1470498, tasklistId: 4073200 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   taskId?: number,
>   projectId?: number,
>   tasklistId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `affectedTaskIds` | `string \| number \| boolean \| null` | No | — |

***

### countCompleted

`tasks.countCompleted`

Count completed tasks.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.countCompleted({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   value?: number | null
> } | null
> ```

***

### countLate

`tasks.countLate`

Count late tasks.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.countLate({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   value?: number | null
> } | null
> ```

***

### create

`tasks.create`

Create a task in a task list.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.create({
	path: { tasklistId: 4073104 },
	body: {
		task: { name: 'Draft the launch post', description: 'First draft by Friday' },
		taskOptions: { notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   tasklistId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachmentOptions?: {
>     removeOtherFiles?: boolean
>   },
>   attachments?: {
>     files?: {
>       categoryId?: number,
>       id?: number
>     }[],
>     pendingFiles?: {
>       categoryId?: number,
>       reference?: string
>     }[]
>   },
>   predecessors?: {
>     id?: number,
>     type?: string
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   task: {
>     allocationId?: number,
>     assignees?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     attachmentIds?: number[],
>     changeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     commentFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completedAt?: string,
>     completedBy?: number,
>     createdAt?: string,
>     createdBy?: number,
>     crmDealIds?: number[],
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId: number,
>         urlTextToDisplay?: string,
>         value: any
>       }[]
>     } | {
>       countryCode?: string,
>       currencySymbol?: string,
>       customfieldId: number,
>       urlTextToDisplay?: string,
>       value: any
>     }[],
>     descriptionContentType?: string,
>     dueAt?: string,
>     dueDate?: string,
>     estimatedMinutes?: number,
>     grantAccessTo?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     hasDeskTickets?: boolean,
>     name: string,
>     notify?: boolean,
>     originalDueDate?: string,
>     parentTaskId?: number,
>     priority?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: string
>     } | none | "" | low | medium | high,
>     private?: boolean,
>     progress?: number,
>     projectId?: number,
>     reminders?: {
>       isRelative?: boolean,
>       note?: string,
>       relativeNumberDays?: number,
>       remindAt?: string,
>       type?: string,
>       userId?: number
>     }[],
>     repeatOptions?: {
>       duration?: number,
>       editOption?: string,
>       endsAt?: string,
>       frequency?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       monthlyRepeatType?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       rrule?: string,
>       selectedDays?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string[]
>       }
>     },
>     startAt?: string,
>     startDate?: string,
>     status?: string,
>     tagIds?: number[],
>     taskgroupId?: number,
>     tasklistId?: number,
>     templateRoleName?: string,
>     ticketId?: number,
>     description?: string
>   },
>   taskOptions: {
>     appendAssignees?: boolean,
>     checkInvalidusers?: boolean,
>     everyoneMustDo?: boolean,
>     fireWebhook?: boolean,
>     isTemplate?: boolean,
>     logActivity?: boolean,
>     notify: boolean,
>     parseInlineTags?: boolean,
>     positionAfterTaskId?: number,
>     pushDependents?: boolean,
>     pushSubtasks?: boolean,
>     shiftProjectDates?: boolean,
>     useDefaults?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   workflows?: {
>     positionAfterTask?: number,
>     stageId?: number,
>     workflowId?: number
>   },
>   card?: {
>     columnId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### createSubtask

`tasks.createSubtask`

Create a subtask under a task.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.createSubtask({
	path: { taskId: 51453032 },
	body: {
		task: { name: 'Pick the hero image' },
		taskOptions: { notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachmentOptions?: {
>     removeOtherFiles?: boolean
>   },
>   attachments?: {
>     files?: {
>       categoryId?: number,
>       id?: number
>     }[],
>     pendingFiles?: {
>       categoryId?: number,
>       reference?: string
>     }[]
>   },
>   predecessors?: {
>     id?: number,
>     type?: string
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   task: {
>     allocationId?: number,
>     assignees?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     attachmentIds?: number[],
>     changeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     commentFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completedAt?: string,
>     completedBy?: number,
>     createdAt?: string,
>     createdBy?: number,
>     crmDealIds?: number[],
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId: number,
>         urlTextToDisplay?: string,
>         value: any
>       }[]
>     } | {
>       countryCode?: string,
>       currencySymbol?: string,
>       customfieldId: number,
>       urlTextToDisplay?: string,
>       value: any
>     }[],
>     descriptionContentType?: string,
>     dueAt?: string,
>     dueDate?: string,
>     estimatedMinutes?: number,
>     grantAccessTo?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     hasDeskTickets?: boolean,
>     name: string,
>     notify?: boolean,
>     originalDueDate?: string,
>     parentTaskId?: number,
>     priority?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: string
>     } | none | "" | low | medium | high,
>     private?: boolean,
>     progress?: number,
>     projectId?: number,
>     reminders?: {
>       isRelative?: boolean,
>       note?: string,
>       relativeNumberDays?: number,
>       remindAt?: string,
>       type?: string,
>       userId?: number
>     }[],
>     repeatOptions?: {
>       duration?: number,
>       editOption?: string,
>       endsAt?: string,
>       frequency?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       monthlyRepeatType?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       rrule?: string,
>       selectedDays?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string[]
>       }
>     },
>     startAt?: string,
>     startDate?: string,
>     status?: string,
>     tagIds?: number[],
>     taskgroupId?: number,
>     tasklistId?: number,
>     templateRoleName?: string,
>     ticketId?: number,
>     description?: string
>   },
>   taskOptions: {
>     appendAssignees?: boolean,
>     checkInvalidusers?: boolean,
>     everyoneMustDo?: boolean,
>     fireWebhook?: boolean,
>     isTemplate?: boolean,
>     logActivity?: boolean,
>     notify: boolean,
>     parseInlineTags?: boolean,
>     positionAfterTaskId?: number,
>     pushDependents?: boolean,
>     pushSubtasks?: boolean,
>     shiftProjectDates?: boolean,
>     useDefaults?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   workflows?: {
>     positionAfterTask?: number,
>     stageId?: number,
>     workflowId?: number
>   },
>   card?: {
>     columnId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### delete

`tasks.delete`

Delete a task (it goes to the trash).

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.tasks.delete({
	path: { taskId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### get

`tasks.get`

Get one task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.get({
	path: { taskId: 51453032 },
	query: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedBefore?: string,
>   updatedAfter?: string,
>   today?: string,
>   taskFilter?: all | anytime | completed | created | overdue | today | yesterday | started | tomorrow | thisweek | within7 | within14 | within30 | within365 | nodate | noduedate | nostartdate | newTaskDefaults | hasDate | upcoming | within | withinprev,
>   startDate?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | task | tasktime,
>   reportFormat?: html | pdf | csv | xls | xlsx | google-sheets,
>   projectType?: all | normal | tentative | personal | projects-template | tasklists-template,
>   priority?: string,
>   orderMode?: asc | desc,
>   orderBy?: id | startdate | createdat | priority | project | flattenedtasklist | company | manual | active | completedat | duestartdate | alldates | tasklistname | tasklistdisplayorder | tasklistid | duedate | updatedat | taskname | createdby | completedby | assignedto | taskstatus | taskduedate | customfield | estimatedtime | taskgroupid | taskgroupname | projectmanual | stagedisplayorder | stage | parenttask | dateadded | datecompleted | completedatdesc | completeddatedesc | duestartdatedesc | alldatesdesc | duedatedesc | taskgroupdisplayorder | dateupdated | originalduedate | tags,
>   notCompletedBefore?: string,
>   endDate?: string,
>   dueBefore?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   createdFilter?: anytime | today | yesterday | custom,
>   createdDateCode?: string,
>   createdBefore?: string,
>   createdAfter?: string,
>   completedBefore?: string,
>   completedAfter?: string,
>   updatedByUserId?: number,
>   parentTaskId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   includeTaskId?: number,
>   filterId?: number,
>   completedByUserId?: number,
>   useTaskDateRange?: boolean,
>   useStartDatesForTodaysTasks?: boolean,
>   useFormulaFields?: boolean,
>   useAllProjects?: boolean,
>   sortActiveFirst?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   showCompletedLists?: boolean,
>   searchJobRoles?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   onlyUntaggedTasks?: boolean,
>   onlyUnplanned?: boolean,
>   onlyUnassignedTasks?: boolean,
>   onlyTasksWithUnreadComments?: boolean,
>   onlyTasksWithTickets?: boolean,
>   onlyTasksWithEstimatedTime?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyAssignedTasks?: boolean,
>   onlyAssignedRoleTasks?: boolean,
>   onlyAdminProjects?: boolean,
>   nestSubTasks?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeUntaggedTasks?: boolean,
>   includeTomorrow?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTasksWithoutDueDates?: boolean,
>   includeTasksFromDeletedLists?: boolean,
>   includeTasksCount?: boolean,
>   includeRelatedTasks?: boolean,
>   includePrivateItems?: boolean,
>   includeOverdueTasks?: boolean,
>   includeOriginalDueDate?: boolean,
>   includeJobRoleUserIds?: boolean,
>   includeEmailCommentStats?: boolean,
>   includeCustomFields?: boolean,
>   includeCompletedTasks?: boolean,
>   includeCompletedPredecessors?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeCommentStats?: boolean,
>   includeBlocked?: boolean,
>   includeAttachmentCommentStats?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeJobRoles?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   includeAllComments?: boolean,
>   includeAccumulatedTimeTotals?: boolean,
>   hideDeleted?: boolean,
>   groupByTasklist?: boolean,
>   groupByTaskgroup?: boolean,
>   getSubTasks?: boolean,
>   getFiles?: boolean,
>   fallbackToMilestoneDueDate?: boolean,
>   extractTemplateRoleName?: boolean,
>   excludeAssigneeNotOnProjectTeams?: boolean,
>   excludeAssignedToMe?: boolean,
>   deletedOnly?: boolean,
>   completedOnly?: boolean,
>   checkForTimeblocks?: boolean,
>   checkForReminders?: boolean,
>   calculateTasklistDates?: boolean,
>   allowAssigneesOutsideProject?: boolean,
>   workflowIds?: number[],
>   tasksSelectedColumns?: string[],
>   tasklistIds?: number[],
>   taskgroupIds?: number[],
>   taskIncludedSet?: (overdue | nodate | nostartdate | noduedate | nostartwithfutureduedate | taskListNames | projectNames)[],
>   tags?: string[],
>   tagIds?: number[],
>   status?: (upcoming | late | all)[],
>   stageIds?: number[],
>   sort?: string[],
>   skipCRMDealIds?: number[],
>   selectedColumns?: string[],
>   responsiblePartyIds?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectFeaturesEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   portfolioBoardIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | tasklists | parentTasks | companies | teams | users | milestones | comments | comments.users | tags | timeTotals | accumulatedTimeTotals | taskSequences | commentFollowers | changeFollowers | completeFollowers | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | attachments | attachments.users | subtaskStats | timers | predecessors | permissions | jobRoles | proofs | taskgroups | workflows | workflows.stages | customfields | customfieldTasks | tasks)[],
>   ids?: number[],
>   followedByUserIds?: number[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     taskgroups
>   ]?: (id | name | description | displayOrder | projectId | status)[],
>   fields[
>     taskSequences
>   ]?: (id | installationId | frequency | selectedWeekDays | endDate | monthlyRepeatType | duration | rrule)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     jobroles
>   ]?: (id | name)[],
>   fields[
>     groups
>   ]?: (late | today | tomorrow | later-this-week | next-week | later | no-due-date)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldTasks
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   expandedIds?: number[],
>   excludeTagIds?: number[],
>   excludeResponsiblePartyIds?: number[],
>   crmDealIds?: number[],
>   createdByUserIds?: number[],
>   assigneeTypes?: (user | company | team | jobrole | placeholder | assigned | unassigned)[],
>   assigneeTeamIds?: number[],
>   assigneeJobRoleIds?: number[],
>   assigneeCompanyIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### list

`tasks.list`

List tasks. Filter with projectIds, tasklistIds, parentTaskId, responsiblePartyIds, tagIds, completedOnly/includeCompletedTasks, due dates and more.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.list({
	query: {
		projectIds: [1470497],
		includeCompletedTasks: false,
		pageSize: 50,
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedBefore?: string,
>   updatedAfter?: string,
>   today?: string,
>   taskFilter?: all | anytime | completed | created | overdue | today | yesterday | started | tomorrow | thisweek | within7 | within14 | within30 | within365 | nodate | noduedate | nostartdate | newTaskDefaults | hasDate | upcoming | within | withinprev,
>   startDate?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | task | tasktime,
>   reportFormat?: html | pdf | csv | xls | xlsx | google-sheets,
>   projectType?: all | normal | tentative | personal | projects-template | tasklists-template,
>   priority?: string,
>   orderMode?: asc | desc,
>   orderBy?: id | startdate | createdat | priority | project | flattenedtasklist | company | manual | active | completedat | duestartdate | alldates | tasklistname | tasklistdisplayorder | tasklistid | duedate | updatedat | taskname | createdby | completedby | assignedto | taskstatus | taskduedate | customfield | estimatedtime | taskgroupid | taskgroupname | projectmanual | stagedisplayorder | stage | parenttask | dateadded | datecompleted | completedatdesc | completeddatedesc | duestartdatedesc | alldatesdesc | duedatedesc | taskgroupdisplayorder | dateupdated | originalduedate | tags,
>   notCompletedBefore?: string,
>   endDate?: string,
>   dueBefore?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   createdFilter?: anytime | today | yesterday | custom,
>   createdDateCode?: string,
>   createdBefore?: string,
>   createdAfter?: string,
>   completedBefore?: string,
>   completedAfter?: string,
>   updatedByUserId?: number,
>   parentTaskId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   includeTaskId?: number,
>   filterId?: number,
>   completedByUserId?: number,
>   useTaskDateRange?: boolean,
>   useStartDatesForTodaysTasks?: boolean,
>   useFormulaFields?: boolean,
>   useAllProjects?: boolean,
>   sortActiveFirst?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   showCompletedLists?: boolean,
>   searchJobRoles?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   onlyUntaggedTasks?: boolean,
>   onlyUnplanned?: boolean,
>   onlyUnassignedTasks?: boolean,
>   onlyTasksWithUnreadComments?: boolean,
>   onlyTasksWithTickets?: boolean,
>   onlyTasksWithEstimatedTime?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyAssignedTasks?: boolean,
>   onlyAssignedRoleTasks?: boolean,
>   onlyAdminProjects?: boolean,
>   nestSubTasks?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeUntaggedTasks?: boolean,
>   includeTomorrow?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTasksWithoutDueDates?: boolean,
>   includeTasksFromDeletedLists?: boolean,
>   includeTasksCount?: boolean,
>   includeRelatedTasks?: boolean,
>   includePrivateItems?: boolean,
>   includeOverdueTasks?: boolean,
>   includeOriginalDueDate?: boolean,
>   includeJobRoleUserIds?: boolean,
>   includeEmailCommentStats?: boolean,
>   includeCustomFields?: boolean,
>   includeCompletedTasks?: boolean,
>   includeCompletedPredecessors?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeCommentStats?: boolean,
>   includeBlocked?: boolean,
>   includeAttachmentCommentStats?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeJobRoles?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   includeAllComments?: boolean,
>   includeAccumulatedTimeTotals?: boolean,
>   hideDeleted?: boolean,
>   groupByTasklist?: boolean,
>   groupByTaskgroup?: boolean,
>   getSubTasks?: boolean,
>   getFiles?: boolean,
>   fallbackToMilestoneDueDate?: boolean,
>   extractTemplateRoleName?: boolean,
>   excludeAssigneeNotOnProjectTeams?: boolean,
>   excludeAssignedToMe?: boolean,
>   deletedOnly?: boolean,
>   completedOnly?: boolean,
>   checkForTimeblocks?: boolean,
>   checkForReminders?: boolean,
>   calculateTasklistDates?: boolean,
>   allowAssigneesOutsideProject?: boolean,
>   workflowIds?: number[],
>   tasksSelectedColumns?: string[],
>   tasklistIds?: number[],
>   taskgroupIds?: number[],
>   taskIncludedSet?: (overdue | nodate | nostartdate | noduedate | nostartwithfutureduedate | taskListNames | projectNames)[],
>   tags?: string[],
>   tagIds?: number[],
>   status?: (upcoming | late | all)[],
>   stageIds?: number[],
>   sort?: string[],
>   skipCRMDealIds?: number[],
>   selectedColumns?: string[],
>   responsiblePartyIds?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectFeaturesEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   portfolioBoardIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | tasklists | parentTasks | companies | teams | users | milestones | comments | comments.users | tags | timeTotals | accumulatedTimeTotals | taskSequences | commentFollowers | changeFollowers | completeFollowers | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | attachments | attachments.users | subtaskStats | timers | predecessors | permissions | jobRoles | proofs | taskgroups | workflows | workflows.stages | customfields | customfieldTasks | tasks)[],
>   ids?: number[],
>   followedByUserIds?: number[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     taskgroups
>   ]?: (id | name | description | displayOrder | projectId | status)[],
>   fields[
>     taskSequences
>   ]?: (id | installationId | frequency | selectedWeekDays | endDate | monthlyRepeatType | duration | rrule)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     jobroles
>   ]?: (id | name)[],
>   fields[
>     groups
>   ]?: (late | today | tomorrow | later-this-week | next-week | later | no-due-date)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldTasks
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   expandedIds?: number[],
>   excludeTagIds?: number[],
>   excludeResponsiblePartyIds?: number[],
>   crmDealIds?: number[],
>   createdByUserIds?: number[],
>   assigneeTypes?: (user | company | team | jobrole | placeholder | assigned | unassigned)[],
>   assigneeTeamIds?: number[],
>   assigneeJobRoleIds?: number[],
>   assigneeCompanyIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `tasks` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> (
>   {
>     accumulatedEstimatedMinutes?: number | null,
>     assigneeCompanies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeCompanyIds?: (number | null)[] | null,
>     assigneeJobRoleIds?: (number | null)[] | null,
>     assigneeJobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeTeamIds?: (number | null)[] | null,
>     assigneeTeams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeUserIds?: (number | null)[] | null,
>     assigneeUsers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assignees?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     attachments?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     capacities?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     changeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     column?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     commentFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     completedOn?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserId?: number | null,
>     crmDealIds?: (number | null)[] | null,
>     dateUpdated?: string | null,
>     decimalDisplayOrder?: number | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     dependencyIds?: (number | null)[] | null,
>     descriptionContentType?: string | null,
>     displayOrder?: number | null,
>     dueDate?: string | null,
>     dueDateBase?: string | null,
>     dueDateFromMilestone?: boolean | null,
>     dueDateOffset?: number | null,
>     estimateMinutes?: number | null,
>     hasDeskTickets?: boolean | null,
>     hasReminders?: boolean | null,
>     hasTimeblocks?: boolean | null,
>     id?: number | null,
>     isArchived?: boolean | null,
>     isBlocked?: boolean | null,
>     isPrivate?: number | null,
>     latestUpdates?: (
>       {
>         after?: any | null,
>         before?: any | null,
>         field?: string | null
>       } | null
>     )[] | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     meta?: {
>       commentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null,
>       emailCommentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null
>     } | null,
>     name?: string | null,
>     notify?: boolean | null,
>     originalDueDate?: string | null,
>     outOfSequence?: boolean | null,
>     parentTask?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     parentTaskId?: number | null,
>     predecessorIds?: (number | null)[] | null,
>     predecessors?: (
>       {
>         id?: number | null,
>         meta?: {
>           dependancyHardness?: string | null,
>           predecessorTaskMust?: string | null,
>           predecessorType?: string | null,
>           projectId?: string | null,
>           tasklistId?: string | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     priority?: string | null,
>     progress?: number | null,
>     proofs?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     sequence?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     sequenceDueDate?: string | null,
>     sequenceId?: number | null,
>     sequenceRootTask?: boolean | null,
>     sequenceStartDate?: string | null,
>     startDate?: string | null,
>     startDateOffset?: number | null,
>     status?: string | null,
>     subTaskIds?: (number | null)[] | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasklist?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectId?: number | null,
>         projectName?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     tasklistId?: number | null,
>     templateRoleName?: string | null,
>     timer?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     userPermissions?: {
>       canAddSubtasks?: boolean | null,
>       canComplete?: boolean | null,
>       canEdit?: boolean | null,
>       canLogTime?: boolean | null,
>       canViewEstTime?: boolean | null
>     } | null,
>     workflowStages?: (
>       {
>         stageId?: number | null,
>         stageTaskDisplayOrder?: number | null,
>         workflowId?: number | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

### listDependencies

`tasks.listDependencies`

List the tasks that depend on a task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.listDependencies({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `dependents` | `object[] \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] dependents full type
>
> ```ts theme={null}
> (
>   {
>     responsible-party-id?: string | number | boolean | null,
>     predecessorMust?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     hardness?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     dependentCant?: string | number | boolean | null,
>     responsible-party-summary?: string | number | boolean | null,
>     responsible-party-names?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### listPredecessors

`tasks.listPredecessors`

List the tasks a task waits on.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.listPredecessors({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `predecessors` | `object[] \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] predecessors full type
>
> ```ts theme={null}
> (
>   {
>     responsible-party-id?: string | number | boolean | null,
>     predecessorMust?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     hardness?: string | number | boolean | null,
>     projectType?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     dependentCant?: string | number | boolean | null,
>     responsible-party-summary?: string | number | boolean | null,
>     responsible-party-names?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### listRecurring

`tasks.listRecurring`

List the repeats of a recurring task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.listRecurring({
	path: { taskId: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   onlyFutureDates?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `recurring-dates` | `(string \| number \| boolean \| null)[] \| null` | No | — |
| `dates-set` | `object \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

> [accordion] dates-set full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### move

`tasks.move`

Move a task to another project or task list.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.move({
	path: { taskId: '51453032' },
	body: { projectId: 1470498, tasklistId: 4073200 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   taskId?: number,
>   projectId?: number,
>   tasklistId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `affectedTaskIds` | `string \| number \| boolean \| null` | No | — |

***

### quickAdd

`tasks.quickAdd`

Add several tasks to a project at once from lines of text.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.quickAdd({
	path: { projectId: '1470497' },
	body: { content: 'Draft the launch post
Pick the hero image', notify: false },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   content: string,
>   tasklistId?: number,
>   creator-id?: number,
>   notify?: boolean,
>   private?: boolean,
>   todo-item?: {
>     responsible-party-id?: string,
>     start-date?: string,
>     due-date?: string,
>     priority?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `tasklistId` | `string \| number \| boolean \| null` | No | — |
| `success` | `string \| number \| boolean \| null` | No | — |
| `taskIds` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `failed` | `string \| number \| boolean \| null` | No | — |

***

### quickAddSubtasks

`tasks.quickAddSubtasks`

Add several subtasks to a task at once from lines of text.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.quickAddSubtasks({
	path: { id: '51453032' },
	body: { content: 'Write the outline
Find two quotes', notify: false },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   content?: string,
>   tasklistId?: number,
>   creator-id?: number,
>   notify?: boolean,
>   private?: boolean,
>   todo-item?: {
>     responsible-party-id?: string,
>     start-date?: string,
>     due-date?: string,
>     priority?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `tasklistId` | `string \| number \| boolean \| null` | No | — |
| `success` | `string \| number \| boolean \| null` | No | — |
| `taskIds` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `failed` | `string \| number \| boolean \| null` | No | — |

***

### reorder

`tasks.reorder`

Reorder the tasks in a task list.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.reorder({
	path: { id: '4073104' },
	body: {
		todo-items: [{
			todo-item: { id: '51453032' },
		}, {
			todo-item: { id: '51453033' },
		}],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   todo-items?: {
>     todo-item?: {
>       id?: string
>     }
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### setEstimate

`tasks.setEstimate`

Set a task's time estimate.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.setEstimate({
	path: { id: '51453032' },
	body: { taskEstimatedMinutes: 90 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   taskId?: number,
>   taskEstimatedMinutes?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### timeReport

`tasks.timeReport`

Report of time logged against tasks.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.tasks.timeReport({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedBefore?: string,
>   updatedAfter?: string,
>   today?: string,
>   taskFilter?: all | anytime | completed | created | overdue | today | yesterday | started | tomorrow | thisweek | within7 | within14 | within30 | within365 | nodate | noduedate | nostartdate | newTaskDefaults | hasDate | upcoming | within | withinprev,
>   startDate?: string,
>   searchTerm?: string,
>   reportType?: plannedvsactual | task | tasktime,
>   reportFormat?: html | pdf | csv | xls | xlsx | google-sheets,
>   projectType?: all | normal | tentative | personal | projects-template | tasklists-template,
>   priority?: string,
>   orderMode?: asc | desc,
>   orderBy?: id | startdate | createdat | priority | project | flattenedtasklist | company | manual | active | completedat | duestartdate | alldates | tasklistname | tasklistdisplayorder | tasklistid | duedate | updatedat | taskname | createdby | completedby | assignedto | taskstatus | taskduedate | customfield | estimatedtime | taskgroupid | taskgroupname | projectmanual | stagedisplayorder | stage | parenttask | dateadded | datecompleted | completedatdesc | completeddatedesc | duestartdatedesc | alldatesdesc | duedatedesc | taskgroupdisplayorder | dateupdated | originalduedate | tags,
>   notCompletedBefore?: string,
>   endDate?: string,
>   dueBefore?: string,
>   dueAfter?: string,
>   deletedAfter?: string,
>   createdFilter?: anytime | today | yesterday | custom,
>   createdDateCode?: string,
>   createdBefore?: string,
>   createdAfter?: string,
>   completedBefore?: string,
>   completedAfter?: string,
>   updatedByUserId?: number,
>   parentTaskId?: number,
>   pageSize?: number,
>   page?: number,
>   orderByCustomFieldId?: number,
>   includeTaskId?: number,
>   filterId?: number,
>   completedByUserId?: number,
>   useTaskDateRange?: boolean,
>   useStartDatesForTodaysTasks?: boolean,
>   useFormulaFields?: boolean,
>   useAllProjects?: boolean,
>   sortActiveFirst?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   showCompletedLists?: boolean,
>   searchJobRoles?: boolean,
>   searchCompaniesTeams?: boolean,
>   searchAssignees?: boolean,
>   onlyUntaggedTasks?: boolean,
>   onlyUnplanned?: boolean,
>   onlyUnassignedTasks?: boolean,
>   onlyTasksWithUnreadComments?: boolean,
>   onlyTasksWithTickets?: boolean,
>   onlyTasksWithEstimatedTime?: boolean,
>   onlyStarredProjects?: boolean,
>   onlyAssignedTasks?: boolean,
>   onlyAssignedRoleTasks?: boolean,
>   onlyAdminProjects?: boolean,
>   nestSubTasks?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTags?: boolean,
>   isReportDownload?: boolean,
>   includeUpdate?: boolean,
>   includeUntaggedTasks?: boolean,
>   includeTomorrow?: boolean,
>   includeToday?: boolean,
>   includeTentativeProjects?: boolean,
>   includeTeamUserIds?: boolean,
>   includeTasksWithoutDueDates?: boolean,
>   includeTasksFromDeletedLists?: boolean,
>   includeTasksCount?: boolean,
>   includeRelatedTasks?: boolean,
>   includePrivateItems?: boolean,
>   includeOverdueTasks?: boolean,
>   includeOriginalDueDate?: boolean,
>   includeJobRoleUserIds?: boolean,
>   includeEmailCommentStats?: boolean,
>   includeCustomFields?: boolean,
>   includeCompletedTasks?: boolean,
>   includeCompletedPredecessors?: boolean,
>   includeCompanyUserIds?: boolean,
>   includeCommentStats?: boolean,
>   includeBlocked?: boolean,
>   includeAttachmentCommentStats?: boolean,
>   includeAssigneeTeams?: boolean,
>   includeAssigneeJobRoles?: boolean,
>   includeAssigneeCompanies?: boolean,
>   includeArchivedProjects?: boolean,
>   includeAllComments?: boolean,
>   includeAccumulatedTimeTotals?: boolean,
>   hideDeleted?: boolean,
>   groupByTasklist?: boolean,
>   groupByTaskgroup?: boolean,
>   getSubTasks?: boolean,
>   getFiles?: boolean,
>   fallbackToMilestoneDueDate?: boolean,
>   extractTemplateRoleName?: boolean,
>   excludeAssigneeNotOnProjectTeams?: boolean,
>   excludeAssignedToMe?: boolean,
>   deletedOnly?: boolean,
>   completedOnly?: boolean,
>   checkForTimeblocks?: boolean,
>   checkForReminders?: boolean,
>   calculateTasklistDates?: boolean,
>   allowAssigneesOutsideProject?: boolean,
>   workflowIds?: number[],
>   tasksSelectedColumns?: string[],
>   tasklistIds?: number[],
>   taskgroupIds?: number[],
>   taskIncludedSet?: (overdue | nodate | nostartdate | noduedate | nostartwithfutureduedate | taskListNames | projectNames)[],
>   tags?: string[],
>   tagIds?: number[],
>   status?: (upcoming | late | all)[],
>   stageIds?: number[],
>   sort?: string[],
>   skipCRMDealIds?: number[],
>   selectedColumns?: string[],
>   responsiblePartyIds?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectFeaturesEnabled?: (list | board | gantt | table | dashboard | milestones | messages | files | time | notebooks | risks | links | billing | comments | people | settings)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   portfolioBoardIds?: number[],
>   includeCustomFieldIds?: number[],
>   include?: (projects | projects.companies | projects.categories | projects.permissions | projects.integrations | tasklists | parentTasks | companies | teams | users | milestones | comments | comments.users | tags | timeTotals | accumulatedTimeTotals | taskSequences | commentFollowers | changeFollowers | completeFollowers | lockdowns | lockdowns.users | lockdowns.companies | lockdowns.teams | lockdowns.users.companies | lockdowns.companies.users | lockdowns.teams.users | attachments | attachments.users | subtaskStats | timers | predecessors | permissions | jobRoles | proofs | taskgroups | workflows | workflows.stages | customfields | customfieldTasks | tasks)[],
>   ids?: number[],
>   followedByUserIds?: number[],
>   fields[
>     workflows
>   ]?: (id | name | statusId)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     teams
>   ]?: (id | name | teamLogo | teamLogoIcon | teamLogoColor)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     taskgroups
>   ]?: (id | name | description | displayOrder | projectId | status)[],
>   fields[
>     taskSequences
>   ]?: (id | installationId | frequency | selectedWeekDays | endDate | monthlyRepeatType | duration | rrule)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     stages
>   ]?: (id | name | stage)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     milestones
>   ]?: (id | name | description | deadline | completed | projectId | createdOn | lastChangedOn | creatorUserId | reminder | private | lockdownId | status | completedOn | completerId | percentageComplete | project)[],
>   fields[
>     lockdowns
>   ]?: (id | userID | updatedAt | itemType | itemID | grantAccessTo)[],
>   fields[
>     jobroles
>   ]?: (id | name)[],
>   fields[
>     groups
>   ]?: (late | today | tomorrow | later-this-week | next-week | later | no-due-date)[],
>   fields[
>     files
>   ]?: (isPrivate | latestFileVersionNo | versionId | status | description | lockdownId | tagIds | changeFollowers | commentFollowers | originalName | displayName | isLocked | lockedByUserId | lockedDate | size | uploadedDate | uploadedByUserID | updatedAt | deletedAt | deletedBy | fileSource | projectId | numLikes | reactions | versions | downloadURL | previewURL | thumbURL | relatedItems | commentsCount | commentsCountRead | categoryId)[],
>   fields[
>     customfields
>   ]?: (id | projectId | entity | name | description | type | options | visibilities | isPrivate | required | createdAt | createdByUserId | updatedAt | updatedByUserId | deleted | deletedAt | deletedByUserId)[],
>   fields[
>     customfieldTasks
>   ]?: (id | customfieldId | value | createdAt | createdBy)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     comments
>   ]?: (id | objectType | objectId | title | postedAt | postedBy | object | project)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   expandedIds?: number[],
>   excludeTagIds?: number[],
>   excludeResponsiblePartyIds?: number[],
>   crmDealIds?: number[],
>   createdByUserIds?: number[],
>   assigneeTypes?: (user | company | team | jobrole | placeholder | assigned | unassigned)[],
>   assigneeTeamIds?: number[],
>   assigneeJobRoleIds?: number[],
>   assigneeCompanyIds?: number[],
>   CustomFields?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `tasks` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> (
>   {
>     accumulatedEstimatedMinutes?: number | null,
>     assigneeCompanies?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeCompanyIds?: (number | null)[] | null,
>     assigneeJobRoleIds?: (number | null)[] | null,
>     assigneeJobRoles?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeTeamIds?: (number | null)[] | null,
>     assigneeTeams?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assigneeUserIds?: (number | null)[] | null,
>     assigneeUsers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     assignees?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     attachments?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     capacities?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     changeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     column?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     commentFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completeFollowers?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     completedAt?: string | null,
>     completedBy?: number | null,
>     completedOn?: string | null,
>     createdAt?: string | null,
>     createdBy?: number | null,
>     createdByUserId?: number | null,
>     crmDealIds?: (number | null)[] | null,
>     dateUpdated?: string | null,
>     decimalDisplayOrder?: number | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     dependencyIds?: (number | null)[] | null,
>     descriptionContentType?: string | null,
>     displayOrder?: number | null,
>     dueDate?: string | null,
>     dueDateBase?: string | null,
>     dueDateFromMilestone?: boolean | null,
>     dueDateOffset?: number | null,
>     estimateMinutes?: number | null,
>     hasDeskTickets?: boolean | null,
>     hasReminders?: boolean | null,
>     hasTimeblocks?: boolean | null,
>     id?: number | null,
>     isArchived?: boolean | null,
>     isBlocked?: boolean | null,
>     isPrivate?: number | null,
>     latestUpdates?: (
>       {
>         after?: any | null,
>         before?: any | null,
>         field?: string | null
>       } | null
>     )[] | null,
>     lockdown?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     meta?: {
>       commentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null,
>       emailCommentStats?: {
>         read?: number | null,
>         total?: number | null
>       } | null
>     } | null,
>     name?: string | null,
>     notify?: boolean | null,
>     originalDueDate?: string | null,
>     outOfSequence?: boolean | null,
>     parentTask?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     parentTaskId?: number | null,
>     predecessorIds?: (number | null)[] | null,
>     predecessors?: (
>       {
>         id?: number | null,
>         meta?: {
>           dependancyHardness?: string | null,
>           predecessorTaskMust?: string | null,
>           predecessorType?: string | null,
>           projectId?: string | null,
>           tasklistId?: string | null
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     priority?: string | null,
>     progress?: number | null,
>     proofs?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     sequence?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     sequenceDueDate?: string | null,
>     sequenceId?: number | null,
>     sequenceRootTask?: boolean | null,
>     sequenceStartDate?: string | null,
>     startDate?: string | null,
>     startDateOffset?: number | null,
>     status?: string | null,
>     subTaskIds?: (number | null)[] | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     tasklist?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectId?: number | null,
>         projectName?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     tasklistId?: number | null,
>     templateRoleName?: string | null,
>     timer?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     userPermissions?: {
>       canAddSubtasks?: boolean | null,
>       canComplete?: boolean | null,
>       canEdit?: boolean | null,
>       canLogTime?: boolean | null,
>       canViewEstTime?: boolean | null
>     } | null,
>     workflowStages?: (
>       {
>         stageId?: number | null,
>         stageTaskDisplayOrder?: number | null,
>         workflowId?: number | null
>       } | null
>     )[] | null
>   } | null
> )[] | null
> ```

***

### uncomplete

`tasks.uncomplete`

Reopen a completed task.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.uncomplete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`tasks.update`

Update a task (only the fields you send change).

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.tasks.update({
	path: { taskId: 51453032 },
	body: {
		task: { description: 'Second draft' },
		taskOptions: { notify: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   attachmentOptions?: {
>     removeOtherFiles?: boolean
>   },
>   attachments?: {
>     files?: {
>       categoryId?: number,
>       id?: number
>     }[],
>     pendingFiles?: {
>       categoryId?: number,
>       reference?: string
>     }[]
>   },
>   predecessors?: {
>     id?: number,
>     type?: string
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   task: {
>     allocationId?: number,
>     assignees?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     attachmentIds?: number[],
>     changeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     commentFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completeFollowers?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     completedAt?: string,
>     completedBy?: number,
>     createdAt?: string,
>     createdBy?: number,
>     crmDealIds?: number[],
>     customFields?: {
>       Values?: {
>         countryCode?: string,
>         currencySymbol?: string,
>         customfieldId: number,
>         urlTextToDisplay?: string,
>         value: any
>       }[]
>     } | {
>       countryCode?: string,
>       currencySymbol?: string,
>       customfieldId: number,
>       urlTextToDisplay?: string,
>       value: any
>     }[],
>     descriptionContentType?: string,
>     dueAt?: string,
>     dueDate?: string,
>     estimatedMinutes?: number,
>     grantAccessTo?: {
>       companyIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       jobRoleIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       teamIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[],
>       userIds?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: number[]
>       } | number[] | number[]
>     },
>     hasDeskTickets?: boolean,
>     name?: string,
>     notify?: boolean,
>     originalDueDate?: string,
>     parentTaskId?: number,
>     priority?: {
>       Null?: boolean,
>       Set?: boolean,
>       Value?: string
>     } | none | "" | low | medium | high,
>     private?: boolean,
>     progress?: number,
>     projectId?: number,
>     reminders?: {
>       isRelative?: boolean,
>       note?: string,
>       relativeNumberDays?: number,
>       remindAt?: string,
>       type?: string,
>       userId?: number
>     }[],
>     repeatOptions?: {
>       duration?: number,
>       editOption?: string,
>       endsAt?: string,
>       frequency?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       monthlyRepeatType?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string
>       },
>       rrule?: string,
>       selectedDays?: {
>         Null?: boolean,
>         Set?: boolean,
>         Value?: string[]
>       }
>     },
>     startAt?: string,
>     startDate?: string,
>     status?: string,
>     tagIds?: number[],
>     taskgroupId?: number,
>     tasklistId?: number,
>     templateRoleName?: string,
>     ticketId?: number,
>     description?: string
>   },
>   taskOptions: {
>     appendAssignees?: boolean,
>     checkInvalidusers?: boolean,
>     everyoneMustDo?: boolean,
>     fireWebhook?: boolean,
>     isTemplate?: boolean,
>     logActivity?: boolean,
>     notify: boolean,
>     parseInlineTags?: boolean,
>     positionAfterTaskId?: number,
>     pushDependents?: boolean,
>     pushSubtasks?: boolean,
>     shiftProjectDates?: boolean,
>     useDefaults?: boolean,
>     useNotifyViaTWIM?: boolean
>   },
>   workflows?: {
>     positionAfterTask?: number,
>     stageId?: number,
>     workflowId?: number
>   },
>   card?: {
>     columnId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `affected` | `object \| null` | No | — |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `task` | `object \| null` | No | — |

> [accordion] affected full type
>
> ```ts theme={null}
> {
>   linkedCardId?: number | null,
>   linkedColumnId?: number | null,
>   linkedColumnName?: string | null,
>   taskIds?: (number | null)[] | null
> } | null
> ```

> [accordion] included full type
>
> ```ts theme={null}
> {
>   comments?: {
>   } | null,
>   companies?: {
>   } | null,
>   customfieldTasks?: {
>   } | null,
>   customfields?: {
>   } | null,
>   files?: {
>   } | null,
>   jobRoles?: {
>   } | null,
>   lockdowns?: {
>   } | null,
>   milestones?: {
>   } | null,
>   projectCategories?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   proofs?: {
>   } | null,
>   stages?: {
>   } | null,
>   subtaskStats?: {
>   } | null,
>   tags?: {
>   } | null,
>   taskSequences?: {
>   } | null,
>   taskgroups?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   timeTotals?: {
>   } | null,
>   timers?: {
>   } | null,
>   users?: {
>   } | null,
>   workflows?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   tasksCount?: number | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] task full type
>
> ```ts theme={null}
> {
>   accumulatedEstimatedMinutes?: number | null,
>   assigneeCompanies?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeCompanyIds?: (number | null)[] | null,
>   assigneeJobRoleIds?: (number | null)[] | null,
>   assigneeJobRoles?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeTeamIds?: (number | null)[] | null,
>   assigneeTeams?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assigneeUserIds?: (number | null)[] | null,
>   assigneeUsers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   assignees?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   attachments?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   capacities?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   changeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   column?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   commentFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completeFollowers?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   completedAt?: string | null,
>   completedBy?: number | null,
>   completedOn?: string | null,
>   createdAt?: string | null,
>   createdBy?: number | null,
>   createdByUserId?: number | null,
>   crmDealIds?: (number | null)[] | null,
>   dateUpdated?: string | null,
>   decimalDisplayOrder?: number | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   dependencyIds?: (number | null)[] | null,
>   descriptionContentType?: string | null,
>   displayOrder?: number | null,
>   dueDate?: string | null,
>   dueDateBase?: string | null,
>   dueDateFromMilestone?: boolean | null,
>   dueDateOffset?: number | null,
>   estimateMinutes?: number | null,
>   hasDeskTickets?: boolean | null,
>   hasReminders?: boolean | null,
>   hasTimeblocks?: boolean | null,
>   id?: number | null,
>   isArchived?: boolean | null,
>   isBlocked?: boolean | null,
>   isPrivate?: number | null,
>   latestUpdates?: (
>     {
>       after?: any | null,
>       before?: any | null,
>       field?: string | null
>     } | null
>   )[] | null,
>   lockdown?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   meta?: {
>     commentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null,
>     emailCommentStats?: {
>       read?: number | null,
>       total?: number | null
>     } | null
>   } | null,
>   name?: string | null,
>   notify?: boolean | null,
>   originalDueDate?: string | null,
>   outOfSequence?: boolean | null,
>   parentTask?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   parentTaskId?: number | null,
>   predecessorIds?: (number | null)[] | null,
>   predecessors?: (
>     {
>       id?: number | null,
>       meta?: {
>         dependancyHardness?: string | null,
>         predecessorTaskMust?: string | null,
>         predecessorType?: string | null,
>         projectId?: string | null,
>         tasklistId?: string | null
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   priority?: string | null,
>   progress?: number | null,
>   proofs?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   sequence?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   sequenceDueDate?: string | null,
>   sequenceId?: number | null,
>   sequenceRootTask?: boolean | null,
>   sequenceStartDate?: string | null,
>   startDate?: string | null,
>   startDateOffset?: number | null,
>   status?: string | null,
>   subTaskIds?: (number | null)[] | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   tasklist?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectId?: number | null,
>       projectName?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   tasklistId?: number | null,
>   templateRoleName?: string | null,
>   timer?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   userPermissions?: {
>     canAddSubtasks?: boolean | null,
>     canComplete?: boolean | null,
>     canEdit?: boolean | null,
>     canLogTime?: boolean | null,
>     canViewEstTime?: boolean | null
>   } | null,
>   workflowStages?: (
>     {
>       stageId?: number | null,
>       stageTaskDisplayOrder?: number | null,
>       workflowId?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

## Teams

### create

`teams.create`

Create a team.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.teams.create({
	body: {
		team: { name: 'Design', userIds: '753865' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   team?: {
>     parentTeamId?: number,
>     name?: string,
>     logoPendingFileRef?: string,
>     logoIcon?: string,
>     logoColor?: string,
>     handle?: string,
>     companyId?: number,
>     projectId?: number,
>     userIds?: string,
>     defaultProjectIds?: string,
>     isPrivate?: boolean,
>     get?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `user` | `object \| null` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   handle?: string | number | boolean | null
> } | null
> ```

***

### createForProject

`teams.createForProject`

Create a project-specific team.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.teams.createForProject({
	path: { id: '1470497' },
	body: {
		team: { name: 'Launch crew', userIds: '753865' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   team?: {
>     parentTeamId?: number,
>     name?: string,
>     logoPendingFileRef?: string,
>     logoIcon?: string,
>     logoColor?: string,
>     handle?: string,
>     userIds?: string,
>     defaultProjectIds?: string,
>     isPrivate?: boolean,
>     get?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `user` | `object \| null` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   handle?: string | number | boolean | null
> } | null
> ```

***

### delete

`teams.delete`

Delete a team.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.teams.delete({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### get

`teams.get`

Get one team.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.get({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   includeSubteams?: boolean,
>   include?: members,
>   showDeleted?: boolean,
>   getEmoji?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `team` | `object \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] team full type
>
> ```ts theme={null}
> {
>   createdByUserId?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   logoIcon?: string | number | boolean | null,
>   deletedDate?: string | number | boolean | null,
>   handle?: string | number | boolean | null,
>   dateUpdated?: string | number | boolean | null,
>   company?: {
>     name?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null,
>   parentTeam?: {
>     name?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null,
>   rootTeam?: {
>     name?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null,
>   numMembers?: string | number | boolean | null,
>   projectId?: string | number | boolean | null,
>   logoUrl?: string | number | boolean | null,
>   members?: (
>     {
>       id?: string | number | boolean | null,
>       name?: string | number | boolean | null
>     } | null
>   )[] | null,
>   logoColor?: string | number | boolean | null,
>   numDirectChildren?: string | number | boolean | null,
>   canEdit?: string | number | boolean | null,
>   updatedByUserId?: string | number | boolean | null,
>   isPrivate?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   dateCreated?: string | number | boolean | null,
>   defaultProjectIds?: string | number | boolean | null,
>   numSubteams?: string | number | boolean | null,
>   deleted?: string | number | boolean | null
> } | null
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### list

`teams.list`

List teams.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: string,
>   page?: number,
>   pageSize?: number,
>   sortBy?: name | picker | dateAdded,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   showDeleted?: boolean,
>   updatedAfterDate?: string,
>   projectIds?: string,
>   userIds?: string,
>   teamIds?: string,
>   companyIds?: string,
>   parentTeamIds?: string,
>   excludeTeamIds?: string,
>   excludeProjectId?: number,
>   excludeDefaultProjectIds?: string,
>   projectCompanyId?: number,
>   includeGlobalTeams?: boolean,
>   includeCompanyTeams?: boolean,
>   includeProjectTeams?: boolean,
>   includePrivateTeams?: boolean,
>   includeSubteams?: boolean,
>   onlyGlobalTeamsWithProjectMembers?: boolean,
>   format?: list | tree,
>   isInPrivacyOfProjectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `teams` | `object[] \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] teams full type
>
> ```ts theme={null}
> (
>   {
>     createdByUserId?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     logoIcon?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     parentTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     rootTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     numMembers?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     logoUrl?: string | number | boolean | null,
>     members?: (
>       {
>         id?: string | number | boolean | null,
>         name?: string | number | boolean | null
>       } | null
>     )[] | null,
>     logoColor?: string | number | boolean | null,
>     numDirectChildren?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     updatedByUserId?: string | number | boolean | null,
>     isPrivate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     defaultProjectIds?: string | number | boolean | null,
>     numSubteams?: string | number | boolean | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### listForCompany

`teams.listForCompany`

List a company's teams.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.listForCompany({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: string,
>   page?: number,
>   pageSize?: number,
>   sortBy?: name | picker | dateAdded,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   showDeleted?: boolean,
>   updatedAfterDate?: string,
>   projectIds?: string,
>   userIds?: string,
>   teamIds?: string,
>   companyIds?: string,
>   parentTeamIds?: string,
>   excludeTeamIds?: string,
>   excludeProjectId?: number,
>   excludeDefaultProjectIds?: string,
>   projectCompanyId?: number,
>   includeGlobalTeams?: boolean,
>   includeCompanyTeams?: boolean,
>   includeProjectTeams?: boolean,
>   includeSubteams?: boolean,
>   onlyGlobalTeamsWithProjectMembers?: boolean,
>   format?: list | tree,
>   isInPrivacyOfProjectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `teams` | `object[] \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] teams full type
>
> ```ts theme={null}
> (
>   {
>     createdByUserId?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     logoIcon?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     parentTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     rootTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     numMembers?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     logoUrl?: string | number | boolean | null,
>     members?: (
>       {
>         id?: string | number | boolean | null,
>         name?: string | number | boolean | null
>       } | null
>     )[] | null,
>     logoColor?: string | number | boolean | null,
>     numDirectChildren?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     updatedByUserId?: string | number | boolean | null,
>     isPrivate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     defaultProjectIds?: string | number | boolean | null,
>     numSubteams?: string | number | boolean | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### listForPerson

`teams.listForPerson`

List the teams a person is in.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.listForPerson({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: string,
>   page?: number,
>   pageSize?: number,
>   sortBy?: name | picker | dateAdded,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   showDeleted?: boolean,
>   updatedAfterDate?: string,
>   projectIds?: string,
>   teamIds?: string,
>   companyIds?: string,
>   parentTeamIds?: string,
>   excludeTeamIds?: string,
>   excludeProjectId?: number,
>   excludeDefaultProjectIds?: string,
>   projectCompanyId?: number,
>   includeGlobalTeams?: boolean,
>   includeCompanyTeams?: boolean,
>   includePrivateTeams?: boolean,
>   onlyGlobalTeamsWithProjectMembers?: boolean,
>   format?: list | tree,
>   isInPrivacyOfProjectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `teams` | `object[] \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] teams full type
>
> ```ts theme={null}
> (
>   {
>     createdByUserId?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     logoIcon?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     parentTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     rootTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     numMembers?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     logoUrl?: string | number | boolean | null,
>     members?: (
>       {
>         id?: string | number | boolean | null,
>         name?: string | number | boolean | null
>       } | null
>     )[] | null,
>     logoColor?: string | number | boolean | null,
>     numDirectChildren?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     updatedByUserId?: string | number | boolean | null,
>     isPrivate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     defaultProjectIds?: string | number | boolean | null,
>     numSubteams?: string | number | boolean | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### listForProject

`teams.listForProject`

List the teams on a project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.listForProject({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: string,
>   page?: number,
>   pageSize?: number,
>   sortBy?: name | picker | dateAdded,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   showDeleted?: boolean,
>   updatedAfterDate?: string,
>   userIds?: string,
>   teamIds?: string,
>   companyIds?: string,
>   parentTeamIds?: string,
>   excludeTeamIds?: string,
>   excludeProjectId?: number,
>   excludeDefaultProjectIds?: string,
>   projectCompanyId?: number,
>   includeGlobalTeams?: boolean,
>   includeCompanyTeams?: boolean,
>   includeProjectTeams?: boolean,
>   includePrivateTeams?: boolean,
>   includeSubteams?: boolean,
>   onlyGlobalTeamsWithProjectMembers?: boolean,
>   format?: list | tree,
>   isInPrivacyOfProjectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `included` | `(custom \| null)[] \| null` | No | — |
| `teams` | `(custom \| null)[] \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### listMemberIds

`teams.listMemberIds`

The user ids in every team.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.listMemberIds({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `teams` | `object \| null` | No | — |

> [accordion] teams full type
>
> ```ts theme={null}
> {
>   teamId?: (string | number | boolean | null)[] | null
> } | null
> ```

***

### listSubteams

`teams.listSubteams`

List a team's subteams.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.teams.listSubteams({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   include?: string,
>   page?: number,
>   pageSize?: number,
>   sortBy?: name | picker | dateAdded,
>   sortOrder?: asc | desc,
>   searchTerm?: string,
>   getEmoji?: boolean,
>   showDeleted?: boolean,
>   updatedAfterDate?: string,
>   projectIds?: string,
>   userIds?: string,
>   teamIds?: string,
>   companyIds?: string,
>   excludeTeamIds?: string,
>   excludeProjectId?: number,
>   excludeDefaultProjectIds?: string,
>   projectCompanyId?: number,
>   includeGlobalTeams?: boolean,
>   includeCompanyTeams?: boolean,
>   includeProjectTeams?: boolean,
>   includePrivateTeams?: boolean,
>   onlyGlobalTeamsWithProjectMembers?: boolean,
>   format?: list | tree,
>   isInPrivacyOfProjectId?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `teams` | `object[] \| null` | No | — |
| `users` | `object \| null` | No | — |
| `projects` | `object \| null` | No | — |

> [accordion] teams full type
>
> ```ts theme={null}
> (
>   {
>     createdByUserId?: string | number | boolean | null,
>     name?: string | number | boolean | null,
>     logoIcon?: string | number | boolean | null,
>     deletedDate?: string | number | boolean | null,
>     handle?: string | number | boolean | null,
>     dateUpdated?: string | number | boolean | null,
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     parentTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     rootTeam?: {
>       name?: string | number | boolean | null,
>       handle?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     numMembers?: string | number | boolean | null,
>     projectId?: string | number | boolean | null,
>     logoUrl?: string | number | boolean | null,
>     members?: (
>       {
>         id?: string | number | boolean | null,
>         name?: string | number | boolean | null
>       } | null
>     )[] | null,
>     logoColor?: string | number | boolean | null,
>     numDirectChildren?: string | number | boolean | null,
>     canEdit?: string | number | boolean | null,
>     updatedByUserId?: string | number | boolean | null,
>     isPrivate?: string | number | boolean | null,
>     id?: string | number | boolean | null,
>     dateCreated?: string | number | boolean | null,
>     defaultProjectIds?: string | number | boolean | null,
>     numSubteams?: string | number | boolean | null,
>     deleted?: string | number | boolean | null
>   } | null
> )[] | null
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
> } | null
> ```

> [accordion] projects full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### setMembers

`teams.setMembers`

Add members to a team, or replace all of them (action defaults to replace).

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.teams.setMembers({
	path: { id: '63157' },
	body: { userIds: '753865', action: 'add' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   userIds?: string,
>   action?: add | replace
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |

***

### update

`teams.update`

Update a team.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.teams.update({
	path: { id: '63157' },
	body: {
		team: { name: 'Design and brand' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   team?: {
>     parentTeamId?: number,
>     name?: string,
>     logoPendingFileRef?: string,
>     logoIcon?: string,
>     logoColor?: string,
>     handle?: string,
>     companyId?: number,
>     projectId?: number,
>     userIds?: string,
>     defaultProjectIds?: string,
>     isPrivate?: boolean,
>     removeLogo?: boolean,
>     get?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string \| number \| boolean \| null` | No | — |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `user` | `object \| null` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   id?: string | number | boolean | null,
>   name?: string | number | boolean | null,
>   handle?: string | number | boolean | null
> } | null
> ```

***

## Time

### byCompany

`time.byCompany`

Time entries grouped by company.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.byCompany({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   startDate?: string,
>   searchTerm?: string,
>   reportFormat?: string,
>   projectStatus?: active | current | late | upcoming | completed | deleted,
>   orderMode?: asc | desc,
>   orderBy?: company | date | dateupdated | project | task | tasklist | user | description | billed | billable | timespent | id,
>   invoicedType?: all | invoiced | noninvoiced,
>   endDate?: string,
>   deletedAfter?: string,
>   budgetedType?: all | budgeted | nonbudgeted,
>   billableType?: all | billable | nonbillable,
>   updatedBy?: number,
>   ticketId?: number,
>   tasklistId?: number,
>   taskId?: number,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   invoiceId?: number,
>   budgetId?: number,
>   allocationId?: number,
>   useFallbackMethod?: boolean,
>   unattachedTimelogs?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   returnSplitInfo?: boolean,
>   returnCostInfo?: boolean,
>   returnBillableInfo?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllTaskTags?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTaskTags?: boolean,
>   matchAllExcludedProjectTags?: boolean,
>   isReportDownload?: boolean,
>   includeTotals?: boolean,
>   includeTentativeProjects?: boolean,
>   includePermissions?: boolean,
>   includeDescendants?: boolean,
>   includeArchivedProjects?: boolean,
>   deletedOnly?: boolean,
>   checkLocking?: boolean,
>   budgetAllocations?: boolean,
>   ticketIds?: number[],
>   tasklistIds?: number[],
>   taskTagIds?: number[],
>   taskStatuses?: string[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: string[],
>   projectsFromCompanyId?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.companies | projects.companies.currencies | projects.categories | projects.permissions | projects.integrations | tags | tasks | tasks.parentTasks | tasks.tasklists | tasks.users | tasks.tags | users | createdBy | updatedBy | deletedBy | project.billing | project.billing.currencies | projectBudgets | currencies | userRates)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timelogs
>   ]?: (id | dateCreated | minutes | description | timeLogged | billable | deleted | dateDeleted | hasStartTime | dateEdited | deskTicketId | userId | taskId | projectId | loggedByUserId | deletedByUserId | editedByUserId | taskIdPreMove | projectBillingInvoiceId)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeTaskTagIds?: number[],
>   excludeProjectTagIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[],
>   assignedTeamIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `timelogs` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] timelogs full type
>
> ```ts theme={null}
> {
> } | null
> ```

***

### create

`time.create`

Log time on a project.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.time.create({
	path: { projectId: 1470497 },
	body: {
		timelog: {
			description: 'Planning call',
			date: '2026-11-17',
			time: '10:00:00',
			hours: 0,
			minutes: 30,
			isBillable: false,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   projectId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   timelog?: {
>     date?: string,
>     hasStartTime?: boolean,
>     hours?: number,
>     invoiceId?: number,
>     isBillable?: boolean,
>     isUtc?: boolean,
>     minutes?: number,
>     projectId?: number,
>     tagIds?: number[],
>     taskId?: number,
>     ticketId?: number,
>     time?: string,
>     userId?: number,
>     verified?: boolean
>   },
>   timelogOptions?: {
>     fireWebhook?: boolean,
>     logActivity?: boolean,
>     markTaskComplete?: boolean,
>     parseInlineTags?: boolean,
>     useNotifyViaTWIM?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timelog` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timelog full type
>
> ```ts theme={null}
> {
>   assignedTeamIds?: (number | null)[] | null,
>   billable?: boolean | null,
>   billableInfo?: {
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   billableRate?: number | null,
>   budgetAllocations?: (
>     {
>       allocatedMinutes?: number | null,
>       budgetId?: number | null,
>       source?: string | null
>     } | null
>   )[] | null,
>   childTimelogId?: number | null,
>   costInfo?: {
>     originalValue?: {
>       exchangeRate?: {
>         date?: string | null,
>         fromCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         rate?: number | null,
>         source?: string | null,
>         toCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       total?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null
>     } | null,
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   costRate?: number | null,
>   createdAt?: string | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateEdited?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserId?: number | null,
>   deskTicketId?: number | null,
>   editedByUserId?: number | null,
>   hasStartTime?: boolean | null,
>   id?: number | null,
>   isBillable?: boolean | null,
>   isLocked?: boolean | null,
>   loggedBy?: number | null,
>   loggedByUserId?: number | null,
>   minutes?: number | null,
>   parentTimelogId?: number | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoice?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoiceId?: number | null,
>   projectId?: number | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   taskIdPreMove?: number | null,
>   taskPreMove?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeLogged?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null,
>   verified?: boolean | null,
>   verifiedAt?: string | null,
>   verifiedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null
> } | null
> ```

***

### createForTask

`time.createForTask`

Log time on a task.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.time.createForTask({
	path: { taskId: 51453032 },
	body: {
		timelog: {
			description: 'Drafting',
			date: '2026-11-17',
			time: '09:00:00',
			hours: 1,
			minutes: 15,
			isBillable: true,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   taskId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   timelog?: {
>     date?: string,
>     hasStartTime?: boolean,
>     hours?: number,
>     invoiceId?: number,
>     isBillable?: boolean,
>     isUtc?: boolean,
>     minutes?: number,
>     projectId?: number,
>     tagIds?: number[],
>     taskId?: number,
>     ticketId?: number,
>     time?: string,
>     userId?: number,
>     verified?: boolean
>   },
>   timelogOptions?: {
>     fireWebhook?: boolean,
>     logActivity?: boolean,
>     markTaskComplete?: boolean,
>     parseInlineTags?: boolean,
>     useNotifyViaTWIM?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timelog` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timelog full type
>
> ```ts theme={null}
> {
>   assignedTeamIds?: (number | null)[] | null,
>   billable?: boolean | null,
>   billableInfo?: {
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   billableRate?: number | null,
>   budgetAllocations?: (
>     {
>       allocatedMinutes?: number | null,
>       budgetId?: number | null,
>       source?: string | null
>     } | null
>   )[] | null,
>   childTimelogId?: number | null,
>   costInfo?: {
>     originalValue?: {
>       exchangeRate?: {
>         date?: string | null,
>         fromCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         rate?: number | null,
>         source?: string | null,
>         toCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       total?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null
>     } | null,
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   costRate?: number | null,
>   createdAt?: string | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateEdited?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserId?: number | null,
>   deskTicketId?: number | null,
>   editedByUserId?: number | null,
>   hasStartTime?: boolean | null,
>   id?: number | null,
>   isBillable?: boolean | null,
>   isLocked?: boolean | null,
>   loggedBy?: number | null,
>   loggedByUserId?: number | null,
>   minutes?: number | null,
>   parentTimelogId?: number | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoice?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoiceId?: number | null,
>   projectId?: number | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   taskIdPreMove?: number | null,
>   taskPreMove?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeLogged?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null,
>   verified?: boolean | null,
>   verifiedAt?: string | null,
>   verifiedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null
> } | null
> ```

***

### delete

`time.delete`

Delete a time entry.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.time.delete({
	path: { timelogId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timelogId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### estimatedTotals

`time.estimatedTotals`

Estimated time totals per project.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.estimatedTotals({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `projects` | `object[] \| null` | No | — |

> [accordion] projects full type
>
> ```ts theme={null}
> (
>   {
>     company?: {
>       name?: string | number | boolean | null,
>       id?: string | number | boolean | null
>     } | null,
>     name?: string | number | boolean | null,
>     totalEstimatedMins?: string | number | boolean | null,
>     totalEstimatedHours?: string | number | boolean | null,
>     id?: string | number | boolean | null
>   } | null
> )[] | null
> ```

***

### get

`time.get`

Get one time entry.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.get({
	path: { timelogId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timelogId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   startDate?: string,
>   searchTerm?: string,
>   reportFormat?: string,
>   projectStatus?: active | current | late | upcoming | completed | deleted,
>   orderMode?: asc | desc,
>   orderBy?: company | date | dateupdated | project | task | tasklist | user | description | billed | billable | timespent | id,
>   invoicedType?: all | invoiced | noninvoiced,
>   endDate?: string,
>   deletedAfter?: string,
>   budgetedType?: all | budgeted | nonbudgeted,
>   billableType?: all | billable | nonbillable,
>   updatedBy?: number,
>   ticketId?: number,
>   tasklistId?: number,
>   taskId?: number,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   invoiceId?: number,
>   budgetId?: number,
>   allocationId?: number,
>   useFallbackMethod?: boolean,
>   unattachedTimelogs?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   returnSplitInfo?: boolean,
>   returnCostInfo?: boolean,
>   returnBillableInfo?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllTaskTags?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTaskTags?: boolean,
>   matchAllExcludedProjectTags?: boolean,
>   isReportDownload?: boolean,
>   includeTotals?: boolean,
>   includeTentativeProjects?: boolean,
>   includePermissions?: boolean,
>   includeDescendants?: boolean,
>   includeArchivedProjects?: boolean,
>   deletedOnly?: boolean,
>   checkLocking?: boolean,
>   budgetAllocations?: boolean,
>   ticketIds?: number[],
>   tasklistIds?: number[],
>   taskTagIds?: number[],
>   taskStatuses?: string[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: string[],
>   projectsFromCompanyId?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.companies | projects.companies.currencies | projects.categories | projects.permissions | projects.integrations | tags | tasks | tasks.parentTasks | tasks.tasklists | tasks.users | tasks.tags | users | createdBy | updatedBy | deletedBy | project.billing | project.billing.currencies | projectBudgets | currencies | userRates)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timelogs
>   ]?: (id | dateCreated | minutes | description | timeLogged | billable | deleted | dateDeleted | hasStartTime | dateEdited | deskTicketId | userId | taskId | projectId | loggedByUserId | deletedByUserId | editedByUserId | taskIdPreMove | projectBillingInvoiceId)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeTaskTagIds?: number[],
>   excludeProjectTagIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[],
>   assignedTeamIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timelog` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timelog full type
>
> ```ts theme={null}
> {
>   assignedTeamIds?: (number | null)[] | null,
>   billable?: boolean | null,
>   billableInfo?: {
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   billableRate?: number | null,
>   budgetAllocations?: (
>     {
>       allocatedMinutes?: number | null,
>       budgetId?: number | null,
>       source?: string | null
>     } | null
>   )[] | null,
>   childTimelogId?: number | null,
>   costInfo?: {
>     originalValue?: {
>       exchangeRate?: {
>         date?: string | null,
>         fromCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         rate?: number | null,
>         source?: string | null,
>         toCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       total?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null
>     } | null,
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   costRate?: number | null,
>   createdAt?: string | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateEdited?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserId?: number | null,
>   deskTicketId?: number | null,
>   editedByUserId?: number | null,
>   hasStartTime?: boolean | null,
>   id?: number | null,
>   isBillable?: boolean | null,
>   isLocked?: boolean | null,
>   loggedBy?: number | null,
>   loggedByUserId?: number | null,
>   minutes?: number | null,
>   parentTimelogId?: number | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoice?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoiceId?: number | null,
>   projectId?: number | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   taskIdPreMove?: number | null,
>   taskPreMove?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeLogged?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null,
>   verified?: boolean | null,
>   verifiedAt?: string | null,
>   verifiedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null
> } | null
> ```

***

### list

`time.list`

List time entries. Filter with projectIds, taskIds, tasklistIds, assignedToUserIds, startDate/endDate and more.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.list({
	query: {
		projectIds: [1470497],
		startDate: '2026-11-01',
		endDate: '2026-11-17',
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   startDate?: string,
>   searchTerm?: string,
>   reportFormat?: string,
>   projectStatus?: active | current | late | upcoming | completed | deleted,
>   orderMode?: asc | desc,
>   orderBy?: company | date | dateupdated | project | task | tasklist | user | description | billed | billable | timespent | id,
>   invoicedType?: all | invoiced | noninvoiced,
>   endDate?: string,
>   deletedAfter?: string,
>   budgetedType?: all | budgeted | nonbudgeted,
>   billableType?: all | billable | nonbillable,
>   updatedBy?: number,
>   ticketId?: number,
>   tasklistId?: number,
>   taskId?: number,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   invoiceId?: number,
>   budgetId?: number,
>   allocationId?: number,
>   useFallbackMethod?: boolean,
>   unattachedTimelogs?: boolean,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   returnSplitInfo?: boolean,
>   returnCostInfo?: boolean,
>   returnBillableInfo?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllTaskTags?: boolean,
>   matchAllTags?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTaskTags?: boolean,
>   matchAllExcludedProjectTags?: boolean,
>   isReportDownload?: boolean,
>   includeTotals?: boolean,
>   includeTentativeProjects?: boolean,
>   includePermissions?: boolean,
>   includeDescendants?: boolean,
>   includeArchivedProjects?: boolean,
>   deletedOnly?: boolean,
>   checkLocking?: boolean,
>   budgetAllocations?: boolean,
>   ticketIds?: number[],
>   tasklistIds?: number[],
>   taskTagIds?: number[],
>   taskStatuses?: string[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: string[],
>   projectsFromCompanyId?: number[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   include?: (projects | projects.companies | projects.companies.currencies | projects.categories | projects.permissions | projects.integrations | tags | tasks | tasks.parentTasks | tasks.tasklists | tasks.users | tasks.tags | users | createdBy | updatedBy | deletedBy | project.billing | project.billing.currencies | projectBudgets | currencies | userRates)[],
>   ids?: number[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timelogs
>   ]?: (id | dateCreated | minutes | description | timeLogged | billable | deleted | dateDeleted | hasStartTime | dateEdited | deskTicketId | userId | taskId | projectId | loggedByUserId | deletedByUserId | editedByUserId | taskIdPreMove | projectBillingInvoiceId)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     tags
>   ]?: (id | name | color | count)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[],
>   fields[
>     projectcategories
>   ]?: (id | name | color | count | parent | parentId)[],
>   fields[
>     projectIntegrations
>   ]?: (userId | projectId | canAccessBox | canAccessDropbox | canAccessGoogleDocs | canAccessOneDrive | canAccessOneDriveBusiness | canAccessSharePoint)[],
>   fields[
>     companies
>   ]?: (id | name | logoUrl)[],
>   fields[
>     ProjectPermissions
>   ]?: (viewMessagesAndFiles | viewTasksAndMilestones | viewTime | viewNotebooks | viewRiskRegister | viewEstimatedTime | viewInvoices | addTasks | addRisks | manageCustomFields | addExpenses | editAllTasks | addMilestones | addTaskLists | addMessages | addFiles | addTime | addNotebooks | viewLinks | addLinks | canViewForms | addForms | viewAllTimeLogs | setPrivacy | projectAdministrator | viewProjectUpdate | addProjectUpdate | canViewProjectMembers | canViewProjectBudget | canManageProjectBudget | canViewRates | canManageRates | canViewSchedule | canManageSchedule | receiveEmailNotifications | isObserving | isArchived | active | canAccess | inOwnerCompany | canManagePeople | canViewProjectTemplates | canManageProjectTemplates)[],
>   excludeTaskTagIds?: number[],
>   excludeProjectTagIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[],
>   assignedTeamIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `timelogs` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] timelogs full type
>
> ```ts theme={null}
> (
>   {
>     assignedTeamIds?: (number | null)[] | null,
>     billable?: boolean | null,
>     billableInfo?: {
>       rate?: number | null,
>       total?: number | null
>     } | null,
>     billableRate?: number | null,
>     budgetAllocations?: (
>       {
>         allocatedMinutes?: number | null,
>         budgetId?: number | null,
>         source?: string | null
>       } | null
>     )[] | null,
>     childTimelogId?: number | null,
>     costInfo?: {
>       originalValue?: {
>         exchangeRate?: {
>           date?: string | null,
>           fromCurrency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null,
>           rate?: number | null,
>           source?: string | null,
>           toCurrency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null,
>         rate?: {
>           amount?: number | null,
>           currency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null,
>         total?: {
>           amount?: number | null,
>           currency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null
>       } | null,
>       rate?: number | null,
>       total?: number | null
>     } | null,
>     costRate?: number | null,
>     createdAt?: string | null,
>     dateCreated?: string | null,
>     dateDeleted?: string | null,
>     dateEdited?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     deletedByUserId?: number | null,
>     deskTicketId?: number | null,
>     editedByUserId?: number | null,
>     hasStartTime?: boolean | null,
>     id?: number | null,
>     isBillable?: boolean | null,
>     isLocked?: boolean | null,
>     loggedBy?: number | null,
>     loggedByUserId?: number | null,
>     minutes?: number | null,
>     parentTimelogId?: number | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectBillingInvoice?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectBillingInvoiceId?: number | null,
>     projectId?: number | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     taskId?: number | null,
>     taskIdPreMove?: number | null,
>     taskPreMove?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timeLogged?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null,
>     verified?: boolean | null,
>     verifiedAt?: string | null,
>     verifiedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   } | null
> )[] | null
> ```

***

### loggedByPerson

`time.loggedByPerson`

Time a person logged, by day.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.loggedByPerson({
	path: { id: '1' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   m?: string,
>   y?: string,
>   page?: number,
>   pageSize?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `STATUS` | `string \| number \| boolean \| null` | No | — |
| `user` | `object \| null` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   billable?: (
>     {
>     } | null
>   )[] | null,
>   firstname?: string | number | boolean | null,
>   nonbillable?: (
>     {
>     } | null
>   )[] | null,
>   endepoch?: string | number | boolean | null,
>   id?: string | number | boolean | null,
>   startepoch?: string | number | boolean | null,
>   lastname?: string | number | boolean | null
> } | null
> ```

***

### report

`time.report`

Time report for a date range (startDate and endDate required).

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.report({
	query: { type: 'user', startDate: '2026-11-01', endDate: '2026-11-17' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   type: company | project | user | tasklist | task | team,
>   startDate: string,
>   searchTerm?: string,
>   reportType?: time | loggedtime | userloggedtime | projecttime,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: "" | name | loggedtime | billabletime | nonbillabletime | billedtime | budget | estimatedtime | utilizationtarget | project | user,
>   groupBy?: day | week | month,
>   expandedType?: string,
>   endDate: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   matchAllTags?: boolean,
>   isReportDownload?: boolean,
>   includeCompletedTasks?: boolean,
>   includeArchivedProjects?: boolean,
>   expandAllGroups?: boolean,
>   addChart?: boolean,
>   userIds?: number[],
>   timelogTagIds?: number[],
>   teamIds?: number[],
>   tasklistIds?: number[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: (company | project | user | tasklist | task | team | loggedtime | billabletime | billedtime | nonbillabletime | billablenonbillablesplit | budget | budgetname | estimatedtime | projectType | utilizationTarget)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectCategoryIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | projects | projects.companies | projectBudgets | tasklists | tasklistBudgets | tasks | tasks.parentTasks | teams | users)[],
>   expandedGroupIds?: number[],
>   companyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `timelogs` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] timelogs full type
>
> ```ts theme={null}
> (
>   {
>     assignedTeamIds?: (number | null)[] | null,
>     billable?: boolean | null,
>     billableInfo?: {
>       rate?: number | null,
>       total?: number | null
>     } | null,
>     billableRate?: number | null,
>     budgetAllocations?: (
>       {
>         allocatedMinutes?: number | null,
>         budgetId?: number | null,
>         source?: string | null
>       } | null
>     )[] | null,
>     childTimelogId?: number | null,
>     costInfo?: {
>       originalValue?: {
>         exchangeRate?: {
>           date?: string | null,
>           fromCurrency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null,
>           rate?: number | null,
>           source?: string | null,
>           toCurrency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null,
>         rate?: {
>           amount?: number | null,
>           currency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null,
>         total?: {
>           amount?: number | null,
>           currency?: {
>             id?: number | null,
>             meta?: {
>             } | null,
>             type?: string | null
>           } | null
>         } | null
>       } | null,
>       rate?: number | null,
>       total?: number | null
>     } | null,
>     costRate?: number | null,
>     createdAt?: string | null,
>     dateCreated?: string | null,
>     dateDeleted?: string | null,
>     dateEdited?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     deletedBy?: number | null,
>     deletedByUserId?: number | null,
>     deskTicketId?: number | null,
>     editedByUserId?: number | null,
>     hasStartTime?: boolean | null,
>     id?: number | null,
>     isBillable?: boolean | null,
>     isLocked?: boolean | null,
>     loggedBy?: number | null,
>     loggedByUserId?: number | null,
>     minutes?: number | null,
>     parentTimelogId?: number | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>         companyId?: number | null,
>         companyName?: string | null,
>         name?: string | null,
>         projectNumber?: string | null
>       } | null,
>       type?: string | null
>     } | null,
>     projectBillingInvoice?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectBillingInvoiceId?: number | null,
>     projectId?: number | null,
>     tagIds?: (number | null)[] | null,
>     tags?: (
>       {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     )[] | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     taskId?: number | null,
>     taskIdPreMove?: number | null,
>     taskPreMove?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timeLogged?: string | null,
>     updatedAt?: string | null,
>     updatedBy?: number | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null,
>     verified?: boolean | null,
>     verifiedAt?: string | null,
>     verifiedBy?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   } | null
> )[] | null
> ```

***

### reportByType

`time.reportByType`

Time report grouped by user, project, company or task.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.reportByType({
	path: { type: 'user' },
	query: { startDate: '2026-11-01', endDate: '2026-11-17' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   type: string
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   type?: company | project | user | tasklist | task | team,
>   startDate: string,
>   searchTerm?: string,
>   reportType?: time | loggedtime | userloggedtime | projecttime,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: "" | name | loggedtime | billabletime | nonbillabletime | billedtime | budget | estimatedtime | utilizationtarget | project | user,
>   groupBy?: day | week | month,
>   expandedType?: string,
>   endDate: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   matchAllTags?: boolean,
>   isReportDownload?: boolean,
>   includeCompletedTasks?: boolean,
>   includeArchivedProjects?: boolean,
>   expandAllGroups?: boolean,
>   addChart?: boolean,
>   userIds?: number[],
>   timelogTagIds?: number[],
>   teamIds?: number[],
>   tasklistIds?: number[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: (company | project | user | tasklist | task | team | loggedtime | billabletime | billedtime | nonbillabletime | billablenonbillablesplit | budget | budgetname | estimatedtime | projectType | utilizationTarget)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectCategoryIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | projects | projects.companies | projectBudgets | tasklists | tasklistBudgets | tasks | tasks.parentTasks | teams | users)[],
>   expandedGroupIds?: number[],
>   companyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `time` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projects?: {
>   } | null,
>   tasklistBudgets?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   teams?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] time full type
>
> ```ts theme={null}
> {
>   companies?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       company?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       estimatedTime?: number | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null
>     } | null
>   )[] | null,
>   projects?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       estimatedTime?: number | null,
>       financialBudget?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       project?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       timeBudget?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   tasklists?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       estimatedTime?: number | null,
>       financialBudget?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       tasklist?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       timeBudget?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   tasks?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       estimatedTime?: number | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       parentTask?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       task?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   teams?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       estimatedTime?: number | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       team?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null
>     } | null
>   )[] | null,
>   users?: (
>     {
>       billableTime?: number | null,
>       billedTime?: number | null,
>       estimatedTime?: number | null,
>       loggedTime?: number | null,
>       nonBillableTime?: number | null,
>       user?: {
>         id?: number | null,
>         meta?: {
>         } | null,
>         type?: string | null
>       } | null,
>       utilizationTarget?: number | null
>     } | null
>   )[] | null
> } | null
> ```

***

### reportTotals

`time.reportTotals`

Time report totals for a date range.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.reportTotals({
	query: { startDate: '2026-01-01', endDate: '2026-01-31' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   type?: company | project | user | tasklist | task | team,
>   startDate: string,
>   searchTerm?: string,
>   reportType?: time | loggedtime | userloggedtime | projecttime,
>   reportFormat?: string,
>   projectType?: "" | normal | tasklists-template | projects-template | personal | tentative,
>   orderMode?: asc | desc,
>   orderBy?: "" | name | loggedtime | billabletime | nonbillabletime | billedtime | budget | estimatedtime | utilizationtarget | project | user,
>   groupBy?: day | week | month,
>   expandedType?: string,
>   endDate: string,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   matchAllTags?: boolean,
>   isReportDownload?: boolean,
>   includeCompletedTasks?: boolean,
>   includeArchivedProjects?: boolean,
>   expandAllGroups?: boolean,
>   addChart?: boolean,
>   userIds?: number[],
>   timelogTagIds?: number[],
>   teamIds?: number[],
>   tasklistIds?: number[],
>   taskIds?: number[],
>   tagIds?: number[],
>   selectedColumns?: (company | project | user | tasklist | task | team | loggedtime | billabletime | billedtime | nonbillabletime | billablenonbillablesplit | budget | budgetname | estimatedtime | projectType | utilizationTarget)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectCategoryIds?: number[],
>   jobRoleIds?: number[],
>   include?: (companies | projects | projects.companies | projectBudgets | tasklists | tasklistBudgets | tasks | tasks.parentTasks | teams | users)[],
>   expandedGroupIds?: number[],
>   companyIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `billableTime` | `number \| null` | No | — |
| `billableTimeAverage` | `number \| null` | No | — |
| `billedTime` | `number \| null` | No | — |
| `billedTimeAverage` | `number \| null` | No | — |
| `dates` | `object[] \| null` | No | — |
| `estimatedTime` | `number \| null` | No | — |
| `estimatedTimeAverage` | `number \| null` | No | — |
| `loggedTime` | `number \| null` | No | — |
| `loggedTimeAverage` | `number \| null` | No | — |
| `nonBillableTime` | `number \| null` | No | — |
| `nonBillableTimeAverage` | `number \| null` | No | — |
| `rowsCount` | `number \| null` | No | — |

> [accordion] dates full type
>
> ```ts theme={null}
> (
>   {
>     billableTime?: number | null,
>     billedTime?: number | null,
>     endDate?: string | null,
>     estimatedTime?: number | null,
>     loggedTime?: number | null,
>     nonBillableTime?: number | null,
>     startDate?: string | null,
>     timeLogged?: string | null
>   } | null
> )[] | null
> ```

***

### totals

`time.totals`

Total logged time. Filter with projectIds, tasklistIds, taskIds, userIds.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.totals({
	query: {
		projectIds: [1470497],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfter?: string,
>   startDate?: string,
>   searchTerm?: string,
>   projectStatus?: active | current | late | upcoming | completed | deleted,
>   invoicedType?: all | invoiced | noninvoiced,
>   endDate?: string,
>   budgetedType?: all | budgeted | nonbudgeted,
>   billableType?: all | billable | nonbillable,
>   userId?: number,
>   tasklistId?: number,
>   taskId?: number,
>   projectId?: number,
>   deskTicketId?: number,
>   returnCostInfo?: boolean,
>   returnBillableInfo?: boolean,
>   onlyStarredProjects?: boolean,
>   matchAllProjectTags?: boolean,
>   matchAllExcludedTaskTags?: boolean,
>   matchAllExcludedProjectTags?: boolean,
>   includeTentativeProjects?: boolean,
>   includeDescendants?: boolean,
>   includeArchivedProjects?: boolean,
>   userIds?: number[],
>   tasklistIds?: number[],
>   taskStatuses?: string[],
>   taskIds?: number[],
>   tagIds?: number[],
>   subTaskStatuses?: (all | completed | incomplete | new | reopened | deleted)[],
>   projectTagIds?: number[],
>   projectStatuses?: (active | current | late | upcoming | completed | deleted)[],
>   projectOwnerIds?: number[],
>   projectIds?: number[],
>   projectHealths?: (0 | 1 | 2 | 3 | 0 | 1 | 2 | 3)[],
>   projectCompanyIds?: number[],
>   projectCategoryIds?: number[],
>   excludeTaskTagIds?: number[],
>   excludeProjectTagIds?: number[],
>   companyIds?: number[],
>   assignedToUserIds?: number[],
>   assignedToTeamIds?: number[],
>   assignedToCompanyIds?: number[],
>   assignedTeamIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `financialTotals` | `object \| null` | No | — |
| `subTasks` | `object \| null` | No | — |
| `time-totals` | `object \| null` | No | — |

> [accordion] financialTotals full type
>
> ```ts theme={null}
> {
>   totalCost?: number | null,
>   totalCostBillable?: number | null,
>   totalCostBilled?: number | null
> } | null
> ```

> [accordion] subTasks full type
>
> ```ts theme={null}
> {
>   estimatedMinutes?: number | null,
>   minutes?: number | null,
>   minutesBillable?: number | null
> } | null
> ```

> [accordion] time-totals full type
>
> ```ts theme={null}
> {
>   estimatedMinutes?: number | null,
>   estimatedMinutesActive?: number | null,
>   estimatedMinutesCompleted?: number | null,
>   estimatedMinutesFiltered?: number | null,
>   estimatedMinutesWithLoggedTime?: number | null,
>   minutes?: number | null,
>   minutesBillable?: number | null,
>   minutesBilled?: number | null,
>   minutesNonBillable?: number | null,
>   minutesNonBilled?: number | null
> } | null
> ```

***

### update

`time.update`

Update a time entry (only the fields you send change).

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.time.update({
	path: { timelogId: 1 },
	body: {
		timelog: { minutes: 45 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timelogId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   fireWebhook?: boolean
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   tags?: {
>     color?: string,
>     name?: string,
>     projectId?: number
>   }[],
>   timelog?: {
>     date?: string,
>     hasStartTime?: boolean,
>     hours?: number,
>     invoiceId?: number,
>     isBillable?: boolean,
>     isUtc?: boolean,
>     minutes?: number,
>     projectId?: number,
>     tagIds?: number[],
>     taskId?: number,
>     ticketId?: number,
>     time?: string,
>     userId?: number,
>     verified?: boolean
>   },
>   timelogOptions?: {
>     fireWebhook?: boolean,
>     logActivity?: boolean,
>     markTaskComplete?: boolean,
>     parseInlineTags?: boolean,
>     useNotifyViaTWIM?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timelog` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   billingInvoices?: {
>   } | null,
>   companies?: {
>   } | null,
>   currencies?: {
>   } | null,
>   projectBudgets?: {
>   } | null,
>   projectIntegrations?: {
>   } | null,
>   projectPermissions?: {
>   } | null,
>   projects?: {
>   } | null,
>   tags?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   userRates?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timelog full type
>
> ```ts theme={null}
> {
>   assignedTeamIds?: (number | null)[] | null,
>   billable?: boolean | null,
>   billableInfo?: {
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   billableRate?: number | null,
>   budgetAllocations?: (
>     {
>       allocatedMinutes?: number | null,
>       budgetId?: number | null,
>       source?: string | null
>     } | null
>   )[] | null,
>   childTimelogId?: number | null,
>   costInfo?: {
>     originalValue?: {
>       exchangeRate?: {
>         date?: string | null,
>         fromCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null,
>         rate?: number | null,
>         source?: string | null,
>         toCurrency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       rate?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null,
>       total?: {
>         amount?: number | null,
>         currency?: {
>           id?: number | null,
>           meta?: {
>           } | null,
>           type?: string | null
>         } | null
>       } | null
>     } | null,
>     rate?: number | null,
>     total?: number | null
>   } | null,
>   costRate?: number | null,
>   createdAt?: string | null,
>   dateCreated?: string | null,
>   dateDeleted?: string | null,
>   dateEdited?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   deletedBy?: number | null,
>   deletedByUserId?: number | null,
>   deskTicketId?: number | null,
>   editedByUserId?: number | null,
>   hasStartTime?: boolean | null,
>   id?: number | null,
>   isBillable?: boolean | null,
>   isLocked?: boolean | null,
>   loggedBy?: number | null,
>   loggedByUserId?: number | null,
>   minutes?: number | null,
>   parentTimelogId?: number | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>       companyId?: number | null,
>       companyName?: string | null,
>       name?: string | null,
>       projectNumber?: string | null
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoice?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectBillingInvoiceId?: number | null,
>   projectId?: number | null,
>   tagIds?: (number | null)[] | null,
>   tags?: (
>     {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null
>   )[] | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   taskIdPreMove?: number | null,
>   taskPreMove?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timeLogged?: string | null,
>   updatedAt?: string | null,
>   updatedBy?: number | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null,
>   verified?: boolean | null,
>   verifiedAt?: string | null,
>   verifiedBy?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null
> } | null
> ```

***

### validate

`time.validate`

Check whether a time entry can be logged (needs time approvals on the plan).

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.time.validate({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   date?: string,
>   userIds?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `canCreate` | `boolean \| null` | No | — |
| `existingApproval` | `object[] \| null` | No | — |

> [accordion] existingApproval full type
>
> ```ts theme={null}
> (
>   {
>     id?: number | null,
>     monthDate?: {
>       Month?: number | null,
>       Year?: number | null
>     } | null,
>     userId?: number | null,
>     weekDate?: {
>       Week?: number | null,
>       Year?: number | null
>     } | null
>   } | null
> )[] | null
> ```

***

## Timers

### complete

`timers.complete`

Stop a timer and log its time.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.complete({
	path: { timerId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***

### create

`timers.create`

Start a timer.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.create({
	body: {
		timer: {
			projectId: 1470497,
			taskId: 51453032,
			isBillable: false,
			isRunning: true,
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   timer?: {
>     isBillable?: boolean,
>     isRunning?: boolean,
>     projectId?: number,
>     seconds?: number,
>     stopRunningTimers?: boolean,
>     taskId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***

### delete

`timers.delete`

Delete a timer.

**Risk:** `destructive`

```ts theme={null}
await corsair.teamwork.api.timers.delete({
	path: { timerId: 1 },
	body: {},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   hardDelete?: boolean
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### get

`timers.get`

Get one timer.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.timers.get({
	path: { timerId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   userId?: number,
>   showDeleted?: boolean,
>   include?: (projects | projects.companies | tasks | tasks.parentTasks | tasks.tasklists | users)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***

### list

`timers.list`

List running timers. Filter with userId, projectId, taskId.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.timers.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   userId?: number,
>   taskId?: number,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   runningTimersOnly?: boolean,
>   include?: (projects | projects.companies | tasks | tasks.parentTasks | tasks.tasklists | users)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `timers` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] timers full type
>
> ```ts theme={null}
> (
>   {
>     billable?: boolean | null,
>     createdAt?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     duration?: number | null,
>     id?: number | null,
>     intervals?: (
>       {
>         duration?: number | null,
>         from?: string | null,
>         id?: number | null,
>         to?: string | null
>       } | null
>     )[] | null,
>     lastStartedAt?: string | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     running?: boolean | null,
>     serverTime?: string | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     taskId?: number | null,
>     timeLogId?: number | null,
>     timelog?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timerLastIntervalEnd?: string | null,
>     updatedAt?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null
>   } | null
> )[] | null
> ```

***

### listMine

`timers.listMine`

List the current user's timers.

**Risk:** `read`

```ts theme={null}
await corsair.teamwork.api.timers.listMine({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   updatedAfterDate?: string,
>   updatedAfter?: string,
>   userId?: number,
>   taskId?: number,
>   projectId?: number,
>   pageSize?: number,
>   page?: number,
>   skipCounts?: boolean,
>   showDeleted?: boolean,
>   runningTimersOnly?: boolean,
>   include?: (projects | projects.companies | tasks | tasks.parentTasks | tasks.tasklists | users)[],
>   fields[
>     users
>   ]?: (id | firstName | lastName | title | email | companyId | company | isAdmin | isClientUser | isServiceAccount | type | deleted | avatarUrl | lengthOfDay | workingHoursId | workingHour | userRate | userCost | canAddProjects | updatedAt | teams)[],
>   fields[
>     timers
>   ]?: (id | userId | taskId | projectId | description | running | billable | deleted | dateCreated | dateDeleted | duration | lastStartedAt | serverTime | intervals)[],
>   fields[
>     tasks
>   ]?: (id | name | dateUpdated | parentTaskId | isPrivate | status | tasklistId | startDate | dueDate | estimateMinutes | accumulatedEstimatedMinutes | updatedAt | tasklist)[],
>   fields[
>     tasklists
>   ]?: (id | name | projectId | milestoneId | project | updatedAt)[],
>   fields[
>     projects
>   ]?: (id | name | type | status | company | companyId | categoryId | startPage | logoIcon | logoColor | updatedAt | isStarred | allowNotifyAnyone | notifyTaskAssignee | isBillable | timelogRequiresTask | activePages | projectNumber | projectNumberCounter)[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `meta` | `object \| null` | No | — |
| `timers` | `object[] \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   companies?: {
>   } | null,
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   averageSpend?: number | null,
>   data?: {
>   } | null,
>   financialAverageSpend?: number | null,
>   limit?: number | null,
>   nextCursor?: string | null,
>   page?: {
>     count?: number | null,
>     hasMore?: boolean | null,
>     pageOffset?: number | null,
>     pageSize?: number | null
>   } | null,
>   prevCursor?: string | null,
>   timeAverageSpend?: number | null,
>   totalCapacity?: number | null
> } | null
> ```

> [accordion] timers full type
>
> ```ts theme={null}
> (
>   {
>     billable?: boolean | null,
>     createdAt?: string | null,
>     deleted?: boolean | null,
>     deletedAt?: string | null,
>     duration?: number | null,
>     id?: number | null,
>     intervals?: (
>       {
>         duration?: number | null,
>         from?: string | null,
>         id?: number | null,
>         to?: string | null
>       } | null
>     )[] | null,
>     lastStartedAt?: string | null,
>     project?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     projectId?: number | null,
>     running?: boolean | null,
>     serverTime?: string | null,
>     task?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     taskId?: number | null,
>     timeLogId?: number | null,
>     timelog?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     timerLastIntervalEnd?: string | null,
>     updatedAt?: string | null,
>     user?: {
>       id?: number | null,
>       meta?: {
>       } | null,
>       type?: string | null
>     } | null,
>     userId?: number | null
>   } | null
> )[] | null
> ```

***

### pause

`timers.pause`

Pause a timer.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.pause({
	path: { timerId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***

### resume

`timers.resume`

Resume a paused timer.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.resume({
	path: { timerId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***

### undelete

`timers.undelete`

Restore a deleted timer.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.undelete({
	path: { timerId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output:** `undefined \| object`

> [accordion] Output full type
>
> ```ts theme={null}
> undefined | {
> }
> ```

***

### update

`timers.update`

Edit a timer.

**Risk:** `write`

```ts theme={null}
await corsair.teamwork.api.timers.update({
	path: { timerId: 1 },
	body: {
		timer: { projectId: 1, taskId: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   timerId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   timer?: {
>     isBillable?: boolean,
>     isRunning?: boolean,
>     projectId?: number,
>     seconds?: number,
>     stopRunningTimers?: boolean,
>     taskId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `included` | `object \| null` | No | — |
| `timer` | `object \| null` | No | — |

> [accordion] included full type
>
> ```ts theme={null}
> {
>   projects?: {
>   } | null,
>   tasklists?: {
>   } | null,
>   tasks?: {
>   } | null,
>   users?: {
>   } | null
> } | null
> ```

> [accordion] timer full type
>
> ```ts theme={null}
> {
>   billable?: boolean | null,
>   createdAt?: string | null,
>   deleted?: boolean | null,
>   deletedAt?: string | null,
>   duration?: number | null,
>   id?: number | null,
>   intervals?: (
>     {
>       duration?: number | null,
>       from?: string | null,
>       id?: number | null,
>       to?: string | null
>     } | null
>   )[] | null,
>   lastStartedAt?: string | null,
>   project?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   projectId?: number | null,
>   running?: boolean | null,
>   serverTime?: string | null,
>   task?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   taskId?: number | null,
>   timeLogId?: number | null,
>   timelog?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   timerLastIntervalEnd?: string | null,
>   updatedAt?: string | null,
>   user?: {
>     id?: number | null,
>     meta?: {
>     } | null,
>     type?: string | null
>   } | null,
>   userId?: number | null
> } | null
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.