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

# Hive

Hive is a project management and team collaboration platform for managing actions, projects, workflows, resources, and workspace metadata.

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

## Tools

### Create Action

**Slug:** `HIVE_CREATE_ACTION`

Create a Hive action (task) in a workspace, optionally inside a project and assigned to users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Short task title. |
| `project_id` | string | No | Optional project in which to create the action. |
| `description` | string | No | Optional task details. |
| `assignee_ids` | array | No | Optional Hive user IDs to assign. |
| `workspace_id` | string | Yes | Workspace that will own the action. |

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

### Create Label

**Slug:** `HIVE_CREATE_LABEL`

Create a color-coded label in a Hive workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Label name. |
| `color` | string | Yes | Six-digit hex color including '#', for example #3390dc. |
| `workspace_id` | string | Yes | Workspace that will own the label. |
| `parent_label_id` | string | No | Optional parent label ID for a nested label. |

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

### Delete Action

**Slug:** `HIVE_DELETE_ACTION`

Soft-delete one Hive action by ID. Hive preserves soft-delete semantics; this tool does not permanently erase the action. Deleting an action that is already gone succeeds rather than failing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action_id` | string | Yes | Hive action ID to soft-delete. Use only an action the caller intends to remove. |

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

### Delete Label

**Slug:** `HIVE_DELETE_LABEL`

Delete one label from a Hive workspace. Deleting a label that is already gone succeeds rather than failing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label_id` | string | Yes | Label ID (_id from Hive) to delete. |
| `workspace_id` | string | Yes | Workspace that owns the label. |

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

**Slug:** `HIVE_GET_ACTION`

Get the current details of one Hive action by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action_id` | string | Yes | Hive action ID returned by an action list, search, or create call. |

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

**Slug:** `HIVE_LIST_ACTIONS`

List Hive actions in a workspace, optionally narrowed by project, status, dates, hierarchy, or archive state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum actions to return in this forward page (1-200). |
| `status` | string | No | Filter by exact Hive action status. |
| `deleted` | boolean | No | Filter by soft-deleted state. |
| `sort_by` | string ("_id asc" | "_id desc" | "rank asc" | "rank desc" | "description asc" | "description desc" | "workspace asc" | "workspace desc" | "deleted asc" | "deleted desc" | "deadline asc" | "deadline desc" | "parent asc" | "parent desc" | "projectId asc" | "projectId desc" | "archived asc" | "archived desc" | "modifiedAt asc" | "modifiedAt desc" | "createdAt asc" | "createdAt desc" | "priorityLevelId asc" | "priorityLevelId desc" | "checkedDate asc" | "checkedDate desc") | No | Sort actions by a supported Hive field in ascending or descending order. |
| `archived` | boolean | No | Filter by archived state. |
| `end_date` | string | No | Upper deadline bound in YYYY-MM-DD format. |
| `project_id` | string | No | Restrict actions to one project. |
| `start_date` | string | No | Lower deadline bound in YYYY-MM-DD format. |
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `workspace_id` | string | Yes | Hive workspace ID from HIVE_LIST_WORKSPACES. |
| `parent_action_id` | string | No | Return direct children of this parent action. |
| `include_total_count` | boolean | No | Request pageInfo.totalCount when true. False is omitted because Hive treats any serialized value as enabled. |

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

**Slug:** `HIVE_LIST_LABELS`

List labels configured in a Hive workspace and return label IDs usable in action search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum labels to return in this forward page (1-200). |
| `sort_by` | string ("name asc" | "name desc" | "createdAt asc" | "createdAt desc") | No | Sort labels by name or creation time in ascending or descending order. |
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `workspace_id` | string | Yes | Hive workspace ID from HIVE_LIST_WORKSPACES. |

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

**Slug:** `HIVE_LIST_PROJECTS`

List projects in a Hive workspace, with optional archive and parent-project filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum projects to return in this forward page (1-200). |
| `sort_by` | string ("createdAt asc" | "createdAt desc" | "modifiedAt asc" | "modifiedAt desc" | "rank asc" | "rank desc") | No | Sort projects by creation time, modification time, or rank in ascending or descending order. |
| `archived` | boolean | No | Filter projects by archived state; omit to include both active and archived projects. |
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `workspace_id` | string | Yes | Hive workspace ID from HIVE_LIST_WORKSPACES. |
| `parent_project_id` | string | No | Return only children of this parent project ID. |
| `include_total_count` | boolean | No | Request pageInfo.totalCount when true; treat it as advisory because visibility may differ from totalCount. |

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

**Slug:** `HIVE_LIST_WORKSPACES`

List Hive workspaces accessible to the connected API key and return IDs needed by workspace-scoped tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum workspaces to return in this forward page (1-200). |
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |
| `include_total_count` | boolean | No | Request pageInfo.totalCount when true; false is omitted upstream. |

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

### Search Actions

**Slug:** `HIVE_SEARCH_ACTIONS`

Search action titles in a Hive workspace and return one offset-based result page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of matching actions to skip; increase by limit for the next page. |
| `limit` | integer | No | Maximum results in this page (1-200). |
| `status` | string | No | Filter by exact Hive action status. |
| `sort_by` | string ("modifiedAt" | "urgency" | "deadline" | "priority") | No | Sort mode: modifiedAt, urgency, deadline, or priority. |
| `archived` | boolean | No | Include or exclude archived results. |
| `end_date` | string | No | Upper date bound in YYYY-MM-DD format. |
| `label_id` | string | No | Filter by label ID. |
| `project_id` | string | No | Restrict search to one project. |
| `start_date` | string | No | Lower date bound in YYYY-MM-DD format. |
| `assignee_id` | string | No | Filter by assignee user ID. |
| `search_term` | string | Yes | Text to match against action titles. |
| `workspace_id` | string | Yes | Hive workspace ID from HIVE_LIST_WORKSPACES. |

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