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

# Resource Planner

Resource Planner helps teams schedule people, manage projects and assignments, and review workspace time entries.

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

## Tools

### Create Assignment

**Slug:** `RESOURCE_PLANNER_CREATE_ASSIGNMENT`

Assign one resource to one project for a date range and return the created assignment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Internal assignment note. |
| `date_to` | string | Yes | Last assignment date in YYYY-MM-DD format; must not precede date_from. |
| `date_from` | string | Yes | First assignment date in YYYY-MM-DD format. |
| `project_id` | string | Yes | Existing project ID; create or list projects to obtain it. |
| `resource_id` | string | Yes | Existing resource ID; create or list resources to obtain it. |
| `hours_per_day` | number | No | Planned hours per day for the assignment. |

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

**Slug:** `RESOURCE_PLANNER_CREATE_PROJECT`

Create a project with a title and optional note, color, and visibility, then return its project ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Internal project note. |
| `color` | string | No | Project color as a six-digit hex value such as #336699. |
| `title` | string | Yes | Project title; must not be empty. |
| `hidden` | boolean | No | Whether to hide the project from normal planning views. |

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

**Slug:** `RESOURCE_PLANNER_CREATE_RESOURCE`

Create a workspace resource with optional capacity, workdays, note, and visibility, then return its resource ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Resource name. |
| `note` | string | No | Internal note for the resource. |
| `hidden` | boolean | No | Whether to hide the resource from normal planning views. |
| `capacity` | number | No | Weekly capacity in hours. |
| `work_days` | array | No | Working weekdays as integers 1-7, Monday through Sunday; each value must be unique. |

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

**Slug:** `RESOURCE_PLANNER_DELETE_ASSIGNMENT`

Permanently delete one assignment by its assignment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assignment_id` | string | Yes | Assignment ID to permanently delete. |

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

**Slug:** `RESOURCE_PLANNER_DELETE_ASSIGNMENTS`

Permanently delete 1-25 assignments sequentially. The operation is not atomic: each ID has its own outcome, successful deletions are not rolled back, and processing stops after an unsafe or ambiguous failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assignment_ids` | array | Yes | Unique IDs of 1-25 assignments to permanently delete. Each assignment is deleted with a separate sequential request. |

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

**Slug:** `RESOURCE_PLANNER_DELETE_PROJECT`

Permanently delete a project and all of its assignments. This cascading deletion cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID to permanently delete. |

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

**Slug:** `RESOURCE_PLANNER_DELETE_RESOURCE`

Permanently delete a resource and all of its assignments. This cascading deletion cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_id` | string | Yes | Resource ID to permanently delete. |

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

**Slug:** `RESOURCE_PLANNER_GET_PROJECT`

Retrieve one current workspace project by its project ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID returned by create or list projects. |

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

**Slug:** `RESOURCE_PLANNER_GET_RESOURCE`

Retrieve one current workspace resource by its resource ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_id` | string | Yes | Resource ID returned by create or list resources. |

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

**Slug:** `RESOURCE_PLANNER_LIST_ASSIGNMENTS`

Return all assignments, optionally narrowed to a project, a resource, or both.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | Return only assignments for this project ID. |
| `resource_id` | string | No | Return only assignments for this resource ID; may be combined with project_id. |

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

Return every project in the connected Resource Planner workspace, including project IDs and editable planning fields.

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

**Slug:** `RESOURCE_PLANNER_LIST_RESOURCES`

Return every resource in the connected Resource Planner workspace, including resource IDs needed for assignment 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 Time Entries

**Slug:** `RESOURCE_PLANNER_LIST_TIME_ENTRIES`

Return one page of workspace time entries, with an optional total-duration summary and a cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum time entries to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to fetch the next page. |
| `include_summary` | boolean | No | Whether to include the total duration across all matching entries. |

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

### Update Assignment

**Slug:** `RESOURCE_PLANNER_UPDATE_ASSIGNMENT`

Replace an assignment's internal note and return all affected assignment IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Replacement internal note for the assignment. |
| `assignment_id` | string | Yes | Assignment ID to update. |

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

### Update Project

**Slug:** `RESOURCE_PLANNER_UPDATE_PROJECT`

Update at least one of a project's title, note, color, or visibility. Omitted fields are preserved by reading the project before updating it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | New project note; omit to preserve the current note. |
| `color` | string | No | New six-digit hex color such as #336699; omit to preserve the current color. |
| `title` | string | No | New non-empty project title; omit to preserve the current title. |
| `hidden` | boolean | No | New hidden state; omit to preserve the current state. |
| `project_id` | string | Yes | Project ID to update. |

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

### Update Resource

**Slug:** `RESOURCE_PLANNER_UPDATE_RESOURCE`

Replace a resource's internal note without changing its scheduling fields, then return the current resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Replacement internal note for the resource. |
| `resource_id` | string | Yes | Resource ID to update. |

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