---
canonical_url: "https://docs.composio.dev/toolkits/pneumatic"
markdown_url: "https://docs.composio.dev/toolkits/pneumatic.md"
product: "platform"
version: null
last_updated: null
---

# Pneumatic

Pneumatic is a workflow management platform for designing reusable processes, running workflows, coordinating tasks, and tracking operational performance.

- **Category:** project management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `PNEUMATIC`
- **Version:** 00000000_00

## Tools

### Get Task

**Slug:** `PNEUMATIC_GET_TASK`

Get one task's instructions, output fields, performers, checklists, due date, and completion state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by List Tasks or embedded in a workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `PNEUMATIC_GET_TEMPLATE`

Get a workflow template's tasks, kickoff fields, owners, and execution settings before running it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | Template ID returned by List Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `PNEUMATIC_GET_WORKFLOW`

Get the current state, tasks, kickoff values, owners, and timing for one workflow run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | integer | Yes | Workflow ID returned by Run Template or List Workflows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets

**Slug:** `PNEUMATIC_LIST_DATASETS`

List reusable Pneumatic datasets available for workflow and template field configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of datasets to return in this page (1-100). |
| `offset` | integer | No | Zero-based number of datasets to skip, usually copied from next_offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `PNEUMATIC_LIST_TASKS`

Find tasks assigned to the connected user or team, including active or completed work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of tasks to return (1-100). |
| `offset` | integer | No | Zero-based number of tasks to skip, usually copied from next_offset. |
| `search` | string | No | Full-text search across task names. |
| `assigned_to` | integer | No | Assigned performer user ID to match. |
| `template_id` | integer | No | Parent template ID to match. |
| `is_completed` | boolean | No | Use false for active tasks or true for completed tasks. |
| `template_task_api_name` | string | No | Task step API name in the template to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `PNEUMATIC_LIST_TEMPLATES`

Find workflow templates the connected user can access, with filters for name, activity, and visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of templates to return in this page (1-100). |
| `offset` | integer | No | Zero-based number of templates to skip, usually copied from next_offset. |
| `search` | string | No | Search template names and other provider-indexed template text. |
| `is_active` | boolean | No | Return only active or inactive templates when set. |
| `is_public` | boolean | No | Return only public or private templates when set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `PNEUMATIC_LIST_WORKFLOWS`

Find workflow runs by text, status, template, starter, current performer, or current task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of workflows to return (1-100). |
| `fields` | string | No | Comma-separated field API names to include in each workflow. |
| `offset` | integer | No | Zero-based number of workflows to skip, usually copied from next_offset. |
| `search` | string | No | Full-text search across workflow names. |
| `status` | string ("running" | "delayed" | "completed" | "done") | No | Workflow status: running, delayed, completed, or done. |
| `is_external` | boolean | No | Filter external or internal workflows when set. |
| `template_id` | string | No | Return workflows created from this template ID. |
| `workflow_starter` | string | No | User ID that started the workflow. |
| `current_performer` | string | No | Current performer user ID to match. |
| `template_task_api_name` | string | No | API name of the current template task to match. |
| `current_performer_group_ids` | string | No | Comma-separated current performer group IDs to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Template

**Slug:** `PNEUMATIC_RUN_TEMPLATE`

Start a workflow from an accessible template, optionally supplying a name, urgency, due date, and kickoff field values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional name for the new workflow. |
| `kickoff` | object | No | Kickoff values keyed by the field api_name values returned by Get Template. |
| `is_urgent` | boolean | No | Whether to mark the new workflow urgent. |
| `template_id` | integer | Yes | Template ID to run; inspect it with Get Template first. |
| `due_date_tsp` | string | No | Optional ISO 8601 due date and time for the workflow. |
| `ancestor_task_id` | integer | No | Parent task ID only when starting this workflow as a subprocess. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Dataset

**Slug:** `PNEUMATIC_SAVE_DATASET`

Create a reusable dataset or update an existing dataset's name, description, or ordered items without exposing deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Dataset name. Required when creating and limited to 200 characters. |
| `items` | array | No | Ordered dataset entries. On update, omission leaves them unchanged. |
| `dataset_id` | integer | No | Existing dataset ID to update; omit it to create a dataset. |
| `description` | string | No | Dataset description. On update, omission leaves it unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Task Completion

**Slug:** `PNEUMATIC_SET_TASK_COMPLETION`

Complete an active task with output values or revert a completed task back to active work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `output` | object | No | For completion, values keyed by output field api_name from Get Task. |
| `comment` | string | No | Optional explanation when reverting a completed task. |
| `task_id` | string | Yes | Task ID to complete or revert. |
| `desired_state` | string ("completed" | "active") | Yes | Set completed to finish an active task, or active to revert a completed task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |