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

# Float

Float is a resource management and project planning platform for scheduling teams, managing project capacity, tracking time, and reporting on utilization.

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

## Tools

### Create Allocation

**Slug:** `FLOAT_CREATE_ALLOCATION`

Schedule work on a Float project for one or more people, or leave it unassigned, with optional phase, status, notes, and recurrence. Supplying a project-task name may create that project-task definition when none matches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Details about the scheduled work. |
| `status` | string ("draft" | "tentative" | "confirmed" | "complete" | "canceled") | No | Initial allocation status. |
| `end_date` | string | Yes | Allocation end date in YYYY-MM-DD format; must not precede start_date. |
| `phase_id` | integer | No | Project phase ID for the allocation. |
| `people_ids` | array | No | One or more positive person IDs to assign; omit to create an unassigned allocation. |
| `project_id` | integer | Yes | ID of the project receiving the allocation. |
| `recurrence` | string ("none" | "weekly" | "monthly" | "every_two_weeks" | "every_three_weeks" | "every_six_weeks" | "every_two_months" | "every_three_months" | "every_six_months" | "yearly") | No | How often the allocation repeats. |
| `start_date` | string | Yes | Allocation start date in YYYY-MM-DD format. |
| `start_time` | string | No | Optional daily start time in 24-hour HH:MM format. |
| `hours_per_day` | number | Yes | Hours scheduled per working day; must be greater than zero. |
| `project_task_id` | integer | No | Existing project task ID; takes precedence over project_task_name. |
| `repeat_end_date` | string | No | Last date for a repeating allocation in YYYY-MM-DD format. Allowed only when recurrence is not none and must not precede end_date. |
| `project_task_name` | string | No | Project task name. Float may create the project-task definition when no matching name exists. Ignored when project_task_id is supplied. |

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

Create a Float project with core scheduling and classification fields. This tool intentionally excludes rates, currencies, budgets, and project-team replacement operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new project. |
| `tags` | array | No | Tags to assign to the project. |
| `color` | string | No | Project color as a hexadecimal value. |
| `notes` | string | No | Planning notes for the project. |
| `status` | string ("draft" | "tentative" | "confirmed" | "completed" | "canceled") | No | Initial lifecycle status. Float automatically selects the first configured project stage matching this status. |
| `billable` | boolean | No | Whether work on this project is billable. |
| `end_date` | string | No | Project end date in YYYY-MM-DD format; must not precede start_date. |
| `client_id` | integer | No | ID of the client that owns the project. |
| `start_date` | string | No | Project start date in YYYY-MM-DD format. |
| `project_code` | string | No | Optional third-party project identifier, unique across projects case-insensitively. |

#### 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 People Capacity Report

**Slug:** `FLOAT_GET_PEOPLE_CAPACITY_REPORT`

Return person-level capacity, scheduled, unscheduled, time-off, billable, and non-billable totals for a required date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | Report end date in YYYY-MM-DD format; must not precede start_date. |
| `people_id` | integer | No | Return report data only for this person ID. |
| `start_date` | string | Yes | Report start date in YYYY-MM-DD format. |

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

Retrieve one Float project by ID, optionally including its phases, project tasks, team, expenses, or currency details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Related project details to include in the response. |
| `project_id` | integer | Yes | ID of the project to retrieve. |

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

**Slug:** `FLOAT_GET_PROJECT_UTILIZATION_REPORT`

Return project-level scheduled, logged, billable, non-billable, budget, and utilization totals for a required date range, optionally for one project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | Report end date in YYYY-MM-DD format; must not precede start_date. |
| `project_id` | integer | No | Return report data only for this project ID. |
| `start_date` | string | Yes | Report start date in YYYY-MM-DD format. |

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

**Slug:** `FLOAT_LIST_ALLOCATIONS`

Find scheduled allocations in Float by project, person, client, phase, project task, date range, billing state, status, or recurrence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Supported field to sort ascending; prefix with '-' for descending. |
| `status` | string ("tentative" | "confirmed" | "complete") | No | Return allocations in this status. |
| `billable` | boolean | No | Return billable allocations when true or non-billable allocations when false. |
| `end_date` | string | No | Inclusive range end in YYYY-MM-DD format; provide together with start_date. |
| `per_page` | integer | No | Maximum allocations to return in this page (1-200). |
| `phase_id` | integer | No | Return allocations for this project phase ID. |
| `client_id` | integer | No | Return allocations for projects belonging to this client ID. |
| `people_id` | integer | No | Return allocations assigned to this person ID. |
| `project_id` | integer | No | Return allocations for this project ID. |
| `recurrence` | string ("none" | "weekly" | "monthly" | "every_two_weeks" | "every_three_weeks" | "every_six_weeks" | "every_two_months" | "every_three_months" | "every_six_months" | "yearly") | No | Return allocations with this recurrence schedule. |
| `start_date` | string | No | Inclusive range start in YYYY-MM-DD format; provide together with end_date. |
| `next_cursor` | string | No | Opaque cursor from a previous response; when supplied it restores that query's filters and fetches the next page. |
| `modified_since` | string | No | Return records modified at or after this YYYY-MM-DD HH:MM:SS value or Unix timestamp. |
| `project_task_id` | integer | No | Return allocations associated with this project task ID. |
| `include_task_days` | boolean | No | Include calculated working dates for each allocation; requires both start_date and end_date. |

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

**Slug:** `FLOAT_LIST_PEOPLE`

Find active people on the Float schedule by default, or filter for archived or all people, employee type, department, tags, and related account details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Supported field to sort ascending; prefix with '-' for descending. |
| `tags` | array | No | Return records matching any exact tag name, case-insensitively. |
| `email` | string | No | Return the person whose email exactly matches this value, case-insensitively. |
| `active` | boolean | No | Return active people when true (the default), archived people when false, or both when explicitly set to null. |
| `include` | array | No | Related details to include in each person record. |
| `per_page` | integer | No | Maximum people to return in this page (1-200). |
| `employment` | string ("full_time" | "part_time") | No | Return only full-time or part-time people. |
| `next_cursor` | string | No | Opaque cursor from a previous response; when supplied it restores that query's filters and fetches the next page. |
| `people_types` | array | No | Return only these person types; role placeholders are not returned unless requested. |
| `department_id` | integer | No | Return only people in this department ID. |
| `modified_since` | string | No | Return records modified at or after this YYYY-MM-DD HH:MM:SS value or Unix timestamp. |

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

Find Float projects by code, client, lifecycle state, billing state, status, or tags, optionally including planning details such as phases, tasks, team, and currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Supported field to sort ascending; prefix with '-' for descending. |
| `tags` | array | No | Return records matching any exact tag name, case-insensitively. |
| `active` | boolean | No | Return active projects when true or archived projects when false. |
| `status` | string ("draft" | "tentative" | "confirmed" | "completed" | "canceled") | No | Return projects in this lifecycle status. |
| `include` | array | No | Related project details to include in each record. |
| `billable` | boolean | No | Return billable projects when true or non-billable projects when false. |
| `per_page` | integer | No | Maximum projects to return in this page (1-200). |
| `client_id` | integer | No | Return only projects belonging to this client ID. |
| `next_cursor` | string | No | Opaque cursor from a previous response; when supplied it restores that query's filters and fetches the next page. |
| `project_code` | string | No | Return the project whose unique project code exactly matches this value, case-insensitively. |
| `modified_since` | string | No | Return records modified at or after this YYYY-MM-DD HH:MM:SS value or Unix timestamp. |

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

**Slug:** `FLOAT_UPDATE_ALLOCATION`

Reschedule or revise selected fields of a Float allocation. Sends only fields explicitly supplied by the caller and preserves Float task IDs in the result. Supplying a project-task name may create that project-task definition when none matches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Non-empty replacement details about the scheduled work. |
| `status` | string ("draft" | "tentative" | "confirmed" | "complete" | "canceled") | No | New allocation status. |
| `end_date` | string | No | New allocation end date in YYYY-MM-DD format. |
| `phase_id` | integer | No | New project phase ID, or null to remove the phase association when Float permits it. |
| `people_ids` | array | No | Non-empty replacement list of person IDs assigned to the allocation. |
| `recurrence` | string ("none" | "weekly" | "monthly" | "every_two_weeks" | "every_three_weeks" | "every_six_weeks" | "every_two_months" | "every_three_months" | "every_six_months" | "yearly") | No | New recurrence schedule. |
| `start_date` | string | No | New allocation start date in YYYY-MM-DD format. |
| `start_time` | string | No | New daily start time in 24-hour HH:MM format, or null to clear it. |
| `allocation_id` | integer | Yes | Float task_id of the allocation to update. |
| `hours_per_day` | number | No | New number of hours scheduled per working day; must be greater than zero. |
| `project_task_id` | integer | No | New project task ID, or null to clear it; do not combine with project_task_name. |
| `repeat_end_date` | string | No | New recurrence end date in YYYY-MM-DD format, or null to clear it. |
| `project_task_name` | string | No | New non-empty project task name when project_task_id is not supplied. Float may create the project-task definition when no matching name exists. |

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

Update selected core identity, schedule, lifecycle, and tag fields on a Float project. This tool does not expose financial configuration or project-team replacement and removal operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New project name. |
| `tags` | array | No | Complete replacement list of project tags; an empty list removes all tags. |
| `color` | string | No | New project color as a hexadecimal value. |
| `notes` | string | No | Replacement planning notes. |
| `active` | boolean | No | Set false to archive the project or true to reactivate it. |
| `status` | string ("draft" | "tentative" | "confirmed" | "completed" | "canceled") | No | New lifecycle status; Float selects the first configured stage for that status. |
| `billable` | boolean | No | Whether work on this project is billable. |
| `end_date` | string | No | New project end date in YYYY-MM-DD format; must not precede start_date when both are supplied. |
| `client_id` | integer | No | New client ID, or null to detach the project when Float permits it. |
| `project_id` | integer | Yes | ID of the project to update. |
| `start_date` | string | No | New project start date in YYYY-MM-DD format. |
| `project_code` | string | No | New third-party project identifier, unique across projects case-insensitively. |

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