# Tasks

> SDK methods for the Tasks module, accessed via `soat.tasks`. See the [Tasks module docs](/docs/modules/workflows) for permissions and data model, and each method's REST page for the full request/response schema.

# Tasks

SDK methods for the Tasks module, accessed via `soat.tasks`. See the [Tasks module docs](/docs/modules/workflows) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.tasks.listTasks()`

List tasks

- Method: `GET`
- Path: `/api/v1/tasks`

```ts
await soat.tasks.listTasks({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/tasks/list-tasks)

### `soat.tasks.createTask()`

Create a task

- Method: `POST`
- Path: `/api/v1/tasks`

```ts
await soat.tasks.createTask({
  body: { workflow_id, title, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/tasks/create-task)

### `soat.tasks.getTask()`

Get a task

- Method: `GET`
- Path: `/api/v1/tasks/{task_id}`

```ts
await soat.tasks.getTask({
  path: { task_id },
});
```

→ [Request & response schema](/docs/api/tasks/get-task)

### `soat.tasks.updateTask()`

Update a task

- Method: `PATCH`
- Path: `/api/v1/tasks/{task_id}`

```ts
await soat.tasks.updateTask({
  path: { task_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/tasks/update-task)

### `soat.tasks.deleteTask()`

Delete a task

- Method: `DELETE`
- Path: `/api/v1/tasks/{task_id}`

```ts
await soat.tasks.deleteTask({
  path: { task_id },
});
```

→ [Request & response schema](/docs/api/tasks/delete-task)

### `soat.tasks.transitionTask()`

Transition a task

- Method: `POST`
- Path: `/api/v1/tasks/{task_id}/transitions`

```ts
await soat.tasks.transitionTask({
  path: { task_id },
  body: { transition, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/tasks/transition-task)

### `soat.tasks.pauseTask()`

Pause a task

- Method: `POST`
- Path: `/api/v1/tasks/{task_id}/pause`

```ts
await soat.tasks.pauseTask({
  path: { task_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/tasks/pause-task)

### `soat.tasks.resumeTask()`

Resume a task

- Method: `POST`
- Path: `/api/v1/tasks/{task_id}/resume`

```ts
await soat.tasks.resumeTask({
  path: { task_id },
});
```

→ [Request & response schema](/docs/api/tasks/resume-task)

### `soat.tasks.getTaskHistory()`

Get task history

- Method: `GET`
- Path: `/api/v1/tasks/{task_id}/history`

```ts
await soat.tasks.getTaskHistory({
  path: { task_id },
});
```

→ [Request & response schema](/docs/api/tasks/get-task-history)