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

# CheckFlow

CheckFlow is a workflow and checklist platform for managing repeatable processes, tasks, templates, teams, data sets, and automation.

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

## Tools

### Create Tag

**Slug:** `CHECKFLOW_CREATE_TAG`

Create a team tag by name, or return the existing same-name tag without creating a duplicate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name to create or look up exactly. |

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

### Find Checklists

**Slug:** `CHECKFLOW_FIND_CHECKLISTS`

Find checklist summaries for a template, optionally filtered by name, tag, or lifecycle status. Returns one page and a cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Optional full or partial tag name filter. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("ALL" | "SCHEDULED" | "INPROGRESS" | "RECENTLYCOMPLETE" | "COMPLETE") | No | Checklist lifecycle status to include. |
| `page_size` | integer | No | Maximum checklist summaries to return in this page (1-10). |
| `template_key` | string | Yes | Template key whose checklist instances to search. |
| `checklist_name` | string | No | Optional full or partial checklist name filter. |

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

**Slug:** `CHECKFLOW_GET_ANALYTICS`

Return checklist and task activity analytics for a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period_end_date` | string | No | Last date to include, formatted as YYYY-MM-DD; omit to use the current date. |
| `period_start_date` | string | Yes | First date to include, formatted as YYYY-MM-DD. |

#### 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 Task Details

**Slug:** `CHECKFLOW_GET_TASK_DETAILS`

Get one checklist task with its controls, comments, and assignees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_key` | string | Yes | Template task key identifying the task within the checklist. |
| `checklist_id` | integer | Yes | Numeric checklist ID containing the 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 |

### Get Team Directory

**Slug:** `CHECKFLOW_GET_TEAM_DIRECTORY`

Return active team members and groups, including each group's membership, optionally filtered by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name_contains` | string | No | Optional case-insensitive name fragment for narrowing members and groups. |

#### 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 Checklist Details

**Slug:** `CHECKFLOW_LIST_CHECKLIST_DETAILS`

Return one page of full checklist instances, including tasks and controls, with a cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Optional full or partial tag name filter. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("ALL" | "SCHEDULED" | "INPROGRESS" | "RECENTLYCOMPLETE" | "COMPLETE") | No | Checklist lifecycle status to include. |
| `page_size` | integer | No | Maximum detailed checklists to return in this page (1-10). |
| `template_key` | string | Yes | Template key whose checklist instances to inspect. |
| `checklist_key` | string | No | Optional checklist key to narrow the result to one instance. |
| `checklist_name` | string | No | Optional full or partial checklist name filter. |

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

**Slug:** `CHECKFLOW_LIST_TAGS`

List the tags available to the connected CheckFlow team.

#### 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:** `CHECKFLOW_LIST_TEMPLATES`

List active checklist templates and their keys for creating or finding checklists.

#### 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 Template Tasks

**Slug:** `CHECKFLOW_LIST_TEMPLATE_TASKS`

List the task keys and names defined by one checklist template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_key` | string | Yes | Template key 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 |

### List Webhook Subscriptions

**Slug:** `CHECKFLOW_LIST_WEBHOOK_SUBSCRIPTIONS`

List webhook subscriptions, optionally filtered by source and event type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string | No | Subscription source to include, or ALL for every source. |
| `event_type` | string ("ALL" | "new_checklist" | "task_completed" | "file_uploaded" | "data_set.record.created" | "data_set.record.updated" | "data_set.record.deleted") | No | Event type to include. |

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