> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Float

The Float connector lets your AI agent act in each user's Float account. Each user connects their own Float access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 70 tools.

**Authentication:** Bearer Token
**Categories:** Project Management, Productivity
**Tools:** 70: 44 read, 23 write, 3 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=FLOAT)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Float connection

   In **AgentKit > Connections**, create a Float connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'float'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Float:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'float_accounts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "float"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Float:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="float_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Float credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'float_account_get',
  toolInput: {
    account_id: 123,
  },
  connector: 'float',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="float_account_get",
    tool_input={
        "account_id": 123,
    },
    connection_name="float",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `float_account_get`

Get Account · Read-only

Retrieve a single account from your Float account by ID.
Returns the account record with fields such as account_id, name, email, timezone, avatar, account_type, access, department_filter.
Use float_account_get when you already have the ID; use float_accounts_list to search or browse.
Requires account_id, typically from float_accounts_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`integer`, required): The account ID. Example: 123
- `expand` (`string`, optional): Use `people_id` to return an additional `people_id` field that can reference a record on `/people`, or `null` if a guest. Example: Expand

Example input: `{"account_id":123}`

### `float_accounts_list`

List Accounts · Read-only

List accounts in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of account records with fields such as account_id, name, email, timezone, avatar, account_type, access, department_filter.
Use float_accounts_list to browse or filter accounts; use float_account_get to fetch one account by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `expand` (`string`, optional): Use `people_id` to return an additional `people_id` field that can reference a record on `/people`, or `null` if a guest. Example: Expand
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_allocation_get`

Get Allocation · Read-only

Retrieve a single allocation from your Float account by ID.
Returns the task record with fields such as task_id, root_task_id, parent_task_id, project_id, phase_id, start_date, end_date, start_time.
Use float_allocation_get when you already have the ID; use float_allocations_list to search or browse.
Requires task_id, typically from float_allocations_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`integer`, required): The allocation as a task ID. Example: 123

Example input: `{"task_id":123}`

### `float_allocations_list`

List Allocations · Read-only

List allocations in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of task records with fields such as task_id, root_task_id, parent_task_id, project_id, phase_id, start_date, end_date, start_time.
Use float_allocations_list to browse or filter allocations; use float_allocation_get to fetch one allocation by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `billable` (`integer`, optional): Filter response on `0` = non-billable or `1` = billable. Example: 1
- `client_id` (`integer`, optional): A client ID associated with projects to filter the response on. Example: 123
- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Will be inclusive of `repeat_end_date` date. Example: 2025-01-31
- `expand` (`string`, optional): Use `task_days` to return an additional array of dates `[YYYY-MM-DD]` calculated by taking into account the date range & `repeat_end_date` of each `task_id` plus holidays & availability of all associated people. (e.g. weekends and holidays dates will not be returned). By default, a date is returned if any person is available, the `people_id` filter may be used to limit this. The `start_date` and `end_date` filters must always be provided. Example: Expand
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `people_id` (`integer`, optional): A people ID to filter the response on. Example: 123
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `phase_id` (`integer`, optional): A phase ID associated with a project to filter the response on. Example: 123
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123
- `repeat_state` (`integer`, optional): Filter response on the repeat state. `0` = No repeat, `1` = Weekly, `2` = Monthly, `3` = Every two weeks, `4` = Every three weeks, `5` = Every six weeks, `6` = Every two months, `7` = Every three months, `8` = Every six months, `9` = Yearly. Example: 1
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `status` (`integer`, optional): Filter response on the Status. `1` = Tentative, `2` = Confirmed, `3` = Complete" Example: 1
- `task_meta_id` (`integer`, optional): A project task ID to filter the response on. Example: 123

Example input: `{}`

### `float_client_get`

Get Client · Read-only

Retrieve a single client from your Float account by ID.
Returns the client record with fields such as client_id, name.
Use float_client_get when you already have the ID; use float_clients_list to search or browse.
Requires client_id, typically from float_clients_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, required): The client's ID. Example: 123

Example input: `{"client_id":123}`

### `float_clients_list`

List Clients · Read-only

List clients in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of client records with fields such as client_id, name.
Use float_clients_list to browse or filter clients; use float_client_get to fetch one client by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_currencies_list`

List Currencies · Read-only

List currencies in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of currency records with fields such as id, source_currency, target_currency, fx_rates.
Use float_currencies_list to browse or filter currencies; use float_currency_get to fetch one currency by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `fx_rates`. Example: Expand
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_currency_get`

Get Currency · Read-only

Retrieve a single currency from your Float account by ID.
Returns the currency record with fields such as id, source_currency, target_currency, fx_rates.
Use float_currency_get when you already have the ID; use float_currencies_list to search or browse.
Requires currency_id, typically from float_currencies_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `currency_id` (`integer`, required): The currency record's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `fx_rates`. Example: Expand

Example input: `{"currency_id":123}`

### `float_department_get`

Get Department · Read-only

Retrieve a single department from your Float account by ID.
Returns the department record with fields such as department_id, parent_id, name.
Use float_department_get when you already have the ID; use float_departments_list to search or browse.
Requires department_id, typically from float_departments_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `department_id` (`integer`, required): The department's id. Example: 123

Example input: `{"department_id":123}`

### `float_departments_list`

List Departments · Read-only

List departments in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of department records with fields such as department_id, parent_id, name.
Use float_departments_list to browse or filter departments; use float_department_get to fetch one department by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_logged_time_get`

Get Logged Time Entry · Read-only

Retrieve a single logged time entry from your Float account by ID.
Returns the loggedtime record with fields such as logged_time_id, people_id, date, reference_date, hours, billable, notes, project_id.
Use float_logged_time_get when you already have the ID; use float_logged_times_list to search or browse.
Requires logged_time_id, typically from float_logged_times_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `logged_time_id` (`string`, required): Unique ID of the specific logged time entry to be retrieved. Example: 123

Example input: `{"logged_time_id":"<logged_time_id>"}`

### `float_logged_times_list`

List Logged Time Entries · Read-only

List logged time entries in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of loggedtime records with fields such as logged_time_id, people_id, date, reference_date, hours, billable, notes, project_id.
Use float_logged_times_list to browse or filter logged time entries; use float_logged_time_get to fetch one logged time entry by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Example: 2025-01-31
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `people_id` (`integer`, optional): A people ID to filter the response on. Example: 123
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `phase_id` (`integer`, optional): A phase ID associated with a project to filter the response on. Example: 123
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `task_meta_id` (`integer`, optional): A project task ID to filter the response on. Example: 123

Example input: `{}`

### `float_milestone_get`

Get Milestone · Read-only

Retrieve a single milestone from your Float account by ID.
Returns the record record with fields such as milestone_id, name, project_id, phase_id, date, end_date, created, modified.
Use float_milestone_get when you already have the ID; use float_milestones_list to search or browse.
Requires milestone_id, typically from float_milestones_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `milestone_id` (`integer`, required): The milestone's ID. Example: 123

Example input: `{"milestone_id":123}`

### `float_milestones_list`

List Milestones · Read-only

List milestones in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of record records with fields such as milestone_id, name, project_id, phase_id, date, end_date, created, modified.
Use float_milestones_list to browse or filter milestones; use float_milestone_get to fetch one milestone by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, optional): A client ID associated with projects to filter the response on. Example: 123
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `phase_id` (`integer`, optional): A phase ID associated with a project to filter the response on. Example: 123
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123

Example input: `{}`

### `float_people_list`

List People · Read-only

List people in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of person records with fields such as people_id, name, people_code, email, job_title, role_id, department, notes.
Use float_people_list to browse or filter people; use float_person_get to fetch one person by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter only on `0` = non-active or `1` = active entities in the response. Example: 1
- `department_id` (`integer`, optional): A department ID to filter the response on. Example: 123
- `email` (`string`, optional): An email address to filter the response (exact match, non-case sensitive) Example: sarahjane@example.com
- `employee_type` (`integer`, optional): The employee type to filter the response on `1` = Full time, `0` = Part time. Example: 1
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `account`, `managers`, and `contracts`. Example: Expand
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `people_code` (`string`, optional): Case-insensitive, URL encoded match of a people code to filter the list response to a single person. Example: People Code
- `people_type_id` (`string`, optional): The people type to filter the response on `1` = Employee, `2` = Contractor, `3` = Placeholder, `4` = Role placeholder. Type `4` is not returned by default. Note: This parameter accepts comma-separated values (e.g., `people_type_id=1,2` or `people_type_id=4`). Example: 123
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified
- `tag_name` (`string`, optional): Case-insensitive, URL encoded, exact text match of tag names to filter the response on. Comma-delimited values will return all matching records. Example: design

Example input: `{}`

### `float_person_get`

Get Person · Read-only

Retrieve a single person from your Float account by ID.
Returns the person record with fields such as people_id, name, people_code, email, job_title, role_id, department, notes.
Use float_person_get when you already have the ID; use float_people_list to search or browse.
Requires people_id, typically from float_people_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `people_id` (`integer`, required): The person's id. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `account`, `managers`, and `contracts`. Example: Expand

Example input: `{"people_id":123}`

### `float_phase_get`

Get Phase · Read-only

Retrieve a single phase from your Float account by ID.
Returns the phase record with fields such as phase_id, project_id, name, color, notes, start_date, end_date, budget_total.
Use float_phase_get when you already have the ID; use float_phases_list to search or browse.
Requires phase_id, typically from float_phases_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phase_id` (`integer`, required): The phase's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `phase_tasks`, `phase_team`. Example: Expand

Example input: `{"phase_id":123}`

### `float_phases_list`

List Phases · Read-only

List phases in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of phase records with fields such as phase_id, project_id, name, color, notes, start_date, end_date, budget_total.
Use float_phases_list to browse or filter phases; use float_phase_get to fetch one phase by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter only on `0` = non-active or `1` = active entities in the response. Example: 1
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `phase_tasks`, `phase_team`. Example: Expand
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `non_billable` (`integer`, optional): Filter response on `0` = billable or `1` = non-billable phases. Example: 1
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified

Example input: `{}`

### `float_project_expense_get`

Get Project Expense · Read-only

Retrieve a single project expense from your Float account by ID.
Returns the project expense record with fields such as id, name, date, cost, project_id, phase_id, billable, markup.
Use float_project_expense_get when you already have the ID; use float_project_expenses_list to search or browse.
Requires project_expense_id, typically from float_project_expenses_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_expense_id` (`integer`, required): The project expense's ID. Example: 123

Example input: `{"project_expense_id":123}`

### `float_project_expenses_list`

List Project Expenses · Read-only

List project expenses in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of project expense records with fields such as id, name, date, cost, project_id, phase_id, billable, markup.
Use float_project_expenses_list to browse or filter project expenses; use float_project_expense_get to fetch one project expense by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified

Example input: `{}`

### `float_project_get`

Get Project · Read-only

Retrieve a single project from your Float account by ID.
Returns the project record with fields such as project_id, name, project_code, client_id, color, notes, tags, budget_type.
Use float_project_get when you already have the ID; use float_projects_list to search or browse.
Requires project_id, typically from float_projects_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`integer`, required): The project's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `expenses`, `phases`, `project_tasks`, `project_team`, `currency`. Example: Expand

Example input: `{"project_id":123}`

### `float_project_stage_get`

Get Project Stage · Read-only

Retrieve a single project stage from your Float account by ID.
Returns the projectstage record with fields such as id, name, description, project_status, active, sort_order, color, created.
Use float_project_stage_get when you already have the ID; use float_project_stages_list to search or browse.
Requires id, typically from float_project_stages_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): The project stage's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `project_count`. Example: Expand

Example input: `{"id":123}`

### `float_project_stages_list`

List Project Stages · Read-only

List project stages in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of projectstage records with fields such as id, name, description, project_status, active, sort_order, color, created.
Use float_project_stages_list to browse or filter project stages; use float_project_stage_get to fetch one project stage by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter only on `0` = non-active or `1` = active entities in the response. Example: 1
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `project_count`. Example: Expand
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified

Example input: `{}`

### `float_project_task_get`

Get Project Task · Read-only

Retrieve a single project task from your Float account by ID.
Returns the project task record with fields such as task_meta_id, project_id, phase_id, task_name, billable, budget, count_tasks, count_logged_time.
Use float_project_task_get when you already have the ID; use float_project_tasks_list to search or browse.
Requires project_task_id, typically from float_project_tasks_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_task_id` (`integer`, required): The project tasks ID as described in the `task_meta_id` field. Example: 123

Example input: `{"project_task_id":123}`

### `float_project_tasks_list`

List Project Tasks · Read-only

List project tasks in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of project task records with fields such as task_meta_id, project_id, phase_id, task_name, billable, budget, count_tasks, count_logged_time.
Use float_project_tasks_list to browse or filter project tasks; use float_project_task_get to fetch one project task by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `billable` (`integer`, optional): Filter response on `1` = billable or `0` = non-billable entities. Example: 1
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified

Example input: `{}`

### `float_project_template_get`

Get Project Template · Read-only

Retrieve a single project template from your Float account by ID.
Returns the projecttemplate record with fields such as project_template_id, name, client_id, color, notes, tags, budget_type, budget_total.
Use float_project_template_get when you already have the ID; use float_project_templates_list to search or browse.
Requires project_template_id, typically from float_project_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_template_id` (`integer`, required): The project template's ID. Example: 123

Example input: `{"project_template_id":123}`

### `float_project_templates_list`

List Project Templates · Read-only

List project templates in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of projecttemplate records with fields such as project_template_id, name, client_id, color, notes, tags, budget_type, budget_total.
Use float_project_templates_list to browse or filter project templates; use float_project_template_get to fetch one project template by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified

Example input: `{}`

### `float_projects_list`

List Projects · Read-only

List projects in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of project records with fields such as project_id, name, project_code, client_id, color, notes, tags, budget_type.
Use float_projects_list to browse or filter projects; use float_project_get to fetch one project by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter only on `0` = non-active or `1` = active entities in the response. Example: 1
- `client_id` (`integer`, optional): A client ID associated with projects to filter the response on. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `expenses`, `phases`, `project_tasks`, `project_team`, `currency`. Example: Expand
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `non_billable` (`integer`, optional): Filter response on `0` = billable or `1` = non-billable projects. Example: 1
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `project_code` (`string`, optional): Case-insensitive, URL encoded match of a project code to filter the list response to a single project. Example: Project Code
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified
- `status` (`integer`, optional): Filter response on the `status` of a project. Example: 1
- `tag_name` (`string`, optional): Case-insensitive, URL encoded, exact text match of tag names to filter the response on. Comma-delimited values will return all matching records. Example: design

Example input: `{}`

### `float_public_holiday_get`

Get Public Holiday · Read-only

Retrieve a single public holiday from your Float account by ID.
Returns the public holiday record with fields such as id, name, region, dates.
Use float_public_holiday_get when you already have the ID; use float_public_holidays_list to search or browse.
Requires public_holiday_id, typically from float_public_holidays_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `public_holiday_id` (`integer`, required): The public holiday's ID. Example: 123
- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Example: 2025-01-31
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `year` (`string`, optional): Returns all results in the given year in format YYYY. Default if omitted is the current year. Overridden by `start_date` and `end_date` parameters. Example: Year. Default: `2023`.

Example input: `{"public_holiday_id":123}`

### `float_public_holidays_list`

List Public Holidays · Read-only

List public holidays in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of public holiday records with fields such as id, name, region, dates.
Use float_public_holidays_list to browse or filter public holidays; use float_public_holiday_get to fetch one public holiday by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Example: 2025-01-31
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `region` (`integer`, optional): Filter results by one or more specific region ID (comma separated) Example: 1
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `year` (`string`, optional): Returns all results in the given year in format YYYY. Default if omitted is the current year. Overridden by `start_date` and `end_date` parameters. Example: Year. Default: `2023`.

Example input: `{}`

### `float_rate_card_get`

Get Rate Card · Read-only

Retrieve a single rate card from your Float account by ID.
Returns the ratecard record with fields such as rate_card_id, name, currency_code, active, client_ids, roles, project_count, created_by.
Use float_rate_card_get when you already have the ID; use float_rate_cards_list to search or browse.
Requires rate_card_id, typically from float_rate_cards_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `rate_card_id` (`integer`, required): The rate card's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `roles`, `project_count`. Example: Expand

Example input: `{"rate_card_id":123}`

### `float_rate_cards_list`

List Rate Cards · Read-only

List rate cards in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of ratecard records with fields such as rate_card_id, name, currency_code, active, client_ids, roles, project_count, created_by.
Use float_rate_cards_list to browse or filter rate cards; use float_rate_card_get to fetch one rate card by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter response on `0` = inactive or `1` = active rate cards. Example: 1
- `client_ids` (`string`, optional): Comma-delimited list of client IDs. Filters the response to rate cards restricted to any of the given clients. Example: 1,2
- `currency_code` (`string`, optional): Filter the response to rate cards with this currency code. Example: Currency Code
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `roles`, `project_count`. Example: Expand
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_report_people_get`

Get People Report · Read-only

Retrieve aggregated schedule utilization for people between two dates.
Returns an object whose people array holds one record per item, with fields such as name, people_id, department_id, department, people_type_id, wk_day_hrs, capacity, timeoff.
Use float_report_people_get for capacity, scheduled, billable and unscheduled hour totals; use float_allocations_list for the individual allocations behind them.
Requires start_date and end_date. Reports are not paginated and have a lower rate limit (30 requests per minute).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Required: End date of the report duration in the format YYYY-MM-DD. Example: 2025-01-31
- `start_date` (`string`, required): Required: Start date of the report duration in the format YYYY-MM-DD. Example: 2025-01-31
- `people_id` (`integer`, optional): A people ID to filter the response on. Example: 123

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `float_report_projects_get`

Get Project Report · Read-only

Retrieve aggregated schedule utilization for projects between two dates.
Returns an object whose projects array holds one record per item, with fields such as name, project_id, client_id, scheduled, billable, nonBillable.
Use float_report_projects_get for capacity, scheduled, billable and unscheduled hour totals; use float_allocations_list for the individual allocations behind them.
Requires start_date and end_date. Reports are not paginated and have a lower rate limit (30 requests per minute).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Required: End date of the report duration in the format YYYY-MM-DD. Example: 2025-01-31
- `start_date` (`string`, required): Required: Start date of the report duration in the format YYYY-MM-DD. Example: 2025-01-31
- `project_id` (`integer`, optional): A project ID to filter the response on. Example: 123

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `float_role_get`

Get Role · Read-only

Retrieve a single role from your Float account by ID.
Returns the role record with fields such as id, name, default_hourly_rate, created, created_by, modified, modified_by, cost_rate_history.
Use float_role_get when you already have the ID; use float_roles_list to search or browse.
Requires role_id, typically from float_roles_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `role_id` (`integer`, required): The role's ID. Example: 123
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `cost_rate_history`, `people_ids`,`people_count`. Example: Expand

Example input: `{"role_id":123}`

### `float_roles_list`

List Roles · Read-only

List roles in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of role records with fields such as id, name, default_hourly_rate, created, created_by, modified, modified_by, cost_rate_history.
Use float_roles_list to browse or filter roles; use float_role_get to fetch one role by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `cost_rate_history`, `people_ids`,`people_count`. Example: Expand
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_status_get`

Get Status · Read-only

Retrieve a single status from your Float account by ID.
Returns the status record with fields such as status_id, status_type_id, people_id, status_name, start_date, end_date, repeat_state, repeat_end_date.
Use float_status_get when you already have the ID; use float_statuses_list to search or browse.
Requires status_id, typically from float_statuses_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `status_id` (`integer`, required): The status's id. Example: 123

Example input: `{"status_id":123}`

### `float_statuses_list`

List Statuses · Read-only

List statuses in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of status records with fields such as status_id, status_type_id, people_id, status_name, start_date, end_date, repeat_state, repeat_end_date.
Use float_statuses_list to browse or filter statuses; use float_status_get to fetch one status by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Example: 2025-01-31
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `people_id` (`integer`, optional): A people ID to filter the response on. Example: 123
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `status_type_id` (`integer`, optional): A status type ID to filter the response on. Example: 123

Example input: `{}`

### `float_team_holiday_get`

Get Team Holiday · Read-only

Retrieve a single team holiday from your Float account by ID.
Returns the holiday record with fields such as holiday_id, name, date, end_date.
Use float_team_holiday_get when you already have the ID; use float_team_holidays_list to search or browse.
Requires holiday_id, typically from float_team_holidays_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `holiday_id` (`integer`, required): The holiday ID. Example: 123

Example input: `{"holiday_id":123}`

### `float_team_holidays_list`

List Team Holidays · Read-only

List team holidays in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of holiday records with fields such as holiday_id, name, date, end_date.
Use float_team_holidays_list to browse or filter team holidays; use float_team_holiday_get to fetch one team holiday by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_timeoff_get`

Get Time Off Entry · Read-only

Retrieve a single time off entry from your Float account by ID.
Returns the timeoff record with fields such as timeoff_id, timeoff_type_id, start_date, end_date, start_time, hours, timeoff_notes, repeat_state.
Use float_timeoff_get when you already have the ID; use float_timeoffs_list to search or browse.
Requires timeoff_id, typically from float_timeoffs_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `timeoff_id` (`integer`, required): The time off's ID. Example: 123

Example input: `{"timeoff_id":123}`

### `float_timeoff_type_get`

Get Time Off Type · Read-only

Retrieve a single time off type from your Float account by ID.
Returns the timeoff type record with fields such as timeoff_type_id, timeoff_type_name, color, active, created_by.
Use float_timeoff_type_get when you already have the ID; use float_timeoff_types_list to search or browse.
Requires timeoff_type_id, typically from float_timeoff_types_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `timeoff_type_id` (`integer`, required): The time off type's ID. Example: 123

Example input: `{"timeoff_type_id":123}`

### `float_timeoff_types_list`

List Time Off Types · Read-only

List time off types in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of timeoff type records with fields such as timeoff_type_id, timeoff_type_name, color, active, created_by.
Use float_timeoff_types_list to browse or filter time off types; use float_timeoff_type_get to fetch one time off type by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): Filter only on `0` = non-active or `1` = active entities in the response. Example: 1
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.

Example input: `{}`

### `float_timeoffs_list`

List Time Off Entries · Read-only

List time off entries in your Float account, with optional filters, sorting, and page-based pagination.
Returns an array of timeoff records with fields such as timeoff_id, timeoff_type_id, start_date, end_date, start_time, hours, timeoff_notes, repeat_state.
Use float_timeoffs_list to browse or filter time off entries; use float_timeoff_get to fetch one time off entry by its ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): End of date range in format YYYY-MM-DD. Must be used together with `start_date`. Example: 2025-01-31
- `fields` (`string`, optional): Comma-delimited set of fields to include in the response. Example: name,email
- `full_day` (`integer`, optional): Filter only on if timeoff is full day: `1` = Yes, `0` = No. Example: 1
- `modified_since` (`string`, optional): Datetime in either `YYYY-MM-DD hh:mm:ss` or as a Unix timestamp in seconds to filter on all records with an equal or later `modified` timestamp. Example: 2025-01-31
- `page` (`integer`, optional): The page number of the page of results to return, default `1`. Default: `1`.
- `per_page` (`integer`, optional): The number of items per page, max is `200`. Default: `50`.
- `sort` (`string`, optional): A field to sort the list values in the response, ascending (default), pre-fix `-` to apply descending. (Limited fields, varies per endpoint) Example: -modified
- `start_date` (`string`, optional): Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
- `status` (`integer`, optional): Filter on the Status of the time off: `1` = tentative, `2` = confirmed. Example: 1
- `timeoff_type_id` (`integer`, optional): Filter on the ID of the timeoff type. Example: 123

Example input: `{}`

### `float_allocation_create`

Create Allocation · Write

Create a new allocation in your Float account. An allocation is a scheduled block of hours for a person (or role placeholder) on a project.
Returns the task record with fields such as task_id, root_task_id, parent_task_id, project_id, phase_id, start_date, end_date, start_time.
Use float_allocation_create to add a new allocation; use float_allocation_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): End date of this allocation. Example: 2023-11-22
- `hours` (`number`, required): Number of hours per day. Example: 4.5
- `project_id` (`integer`, required): The ID of the project for this allocation. Example: 1345
- `start_date` (`string`, required): Start date of this allocation. Example: 2023-11-16
- `name` (`string`, optional): Name of the associated project task. Example: Concepting
- `notes` (`string`, optional): Additional details about the work required. Example: Sketches and wireframes only.
- `parent_task_id` (`integer`, optional): The ID of the direct parent of a linked allocation. Example: 7654321
- `people_id` (`integer`, optional): The ID of the person assigned to the allocation (omit when using `people_ids` field) Example: 11223344
- `people_ids` (`array`, optional): List of one or more people IDs assigned to the allocation (ignored if `people_id` is set) Example: ["1234","5678"]
- `phase_id` (`integer`, optional): The ID of the project phase for this allocation. Example: 153
- `repeat_end_date` (`string`, optional): Date that the repeating allocation will cease. Example: 2023-03-16
- `repeat_state` (`integer`, optional): Frequency that this allocation repeats. `0` = No repeat, `1` = Weekly, `2` = Monthly, `3` = Every two weeks, `4` = Every three weeks, `5` = Every six weeks, `6` = Every two months, `7` = Every three months, `8` = Every six months, `9` = Yearly. Example: 0
- `root_task_id` (`integer`, optional): The ID of the earliest linked allocation in a chain. Example: 1234567
- `start_time` (`string`, optional): Start time in 24 hr format. Example: 14:00
- `status` (`integer`, optional): Status; `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Complete, `4` = Canceled. Example: 2
- `task_meta_id` (`integer`, optional): The ID of the associated project task (named for backwards compatibility), takes higher priority over `name`. Example: 1234567

Example input: `{"end_date":"<end_date>","hours":4.5,"project_id":1345,"start_date":"<start_date>"}`

### `float_allocation_update`

Update Allocation · Write

Update an existing allocation in your Float account; only the fields you provide are changed.
Returns the task record with fields such as task_id, root_task_id, parent_task_id, project_id, phase_id, start_date, end_date, start_time.
Use float_allocation_update to modify a allocation; use float_allocation_create to add a new one.
Requires task_id, typically from float_allocations_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`integer`, required): The allocation as a task ID. Example: 123
- `end_date` (`string`, optional): End date of this allocation. Example: 2023-11-22
- `hours` (`number`, optional): Number of hours per day. Example: 4.5
- `name` (`string`, optional): Name of the associated project task. Example: Concepting
- `notes` (`string`, optional): Additional details about the work required. Example: Sketches and wireframes only.
- `parent_task_id` (`integer`, optional): The ID of the direct parent of a linked allocation. Example: 7654321
- `people_id` (`integer`, optional): The ID of the person assigned to the allocation (omit when using `people_ids` field) Example: 11223344
- `people_ids` (`array`, optional): List of one or more people IDs assigned to the allocation (ignored if `people_id` is set) Example: ["1234","5678"]
- `phase_id` (`integer`, optional): The ID of the project phase for this allocation. Example: 153
- `project_id` (`integer`, optional): The ID of the project for this allocation. Example: 1345
- `repeat_end_date` (`string`, optional): Date that the repeating allocation will cease. Example: 2023-03-16
- `repeat_state` (`integer`, optional): Frequency that this allocation repeats. `0` = No repeat, `1` = Weekly, `2` = Monthly, `3` = Every two weeks, `4` = Every three weeks, `5` = Every six weeks, `6` = Every two months, `7` = Every three months, `8` = Every six months, `9` = Yearly. Example: 0
- `root_task_id` (`integer`, optional): The ID of the earliest linked allocation in a chain. Example: 1234567
- `start_date` (`string`, optional): Start date of this allocation. Example: 2023-11-16
- `start_time` (`string`, optional): Start time in 24 hr format. Example: 14:00
- `status` (`integer`, optional): Status; `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Complete, `4` = Canceled. Example: 2
- `task_meta_id` (`integer`, optional): The ID of the associated project task (named for backwards compatibility), takes higher priority over `name`. Example: 1234567

Example input: `{"task_id":123}`

### `float_client_create`

Create Client · Write

Create a new client in your Float account.
Returns the client record with fields such as client_id, name.
Use float_client_create to add a new client; use float_client_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The name of the client. Example: Red Circle

Example input: `{"name":"<name>"}`

### `float_client_update`

Update Client · Write

Update an existing client in your Float account; only the fields you provide are changed.
Returns the client record with fields such as client_id, name.
Use float_client_update to modify a client; use float_client_create to add a new one.
Requires client_id, typically from float_clients_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, required): The client's ID. Example: 123
- `name` (`string`, optional): The name of the client. Example: Red Circle

Example input: `{"client_id":123}`

### `float_department_create`

Create Department · Write

Create a new department in your Float account.
Returns the department record with fields such as department_id, parent_id, name.
Use float_department_create to add a new department; use float_department_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The name of the department. Example: Engineers
- `parent_id` (`integer`, optional): The ID of this department's parent department (identifies this as a sub-department if not `null`) Example: 123

Example input: `{"name":"<name>"}`

### `float_department_update`

Update Department · Write

Update an existing department in your Float account; only the fields you provide are changed.
Returns the department record with fields such as department_id, parent_id, name.
Use float_department_update to modify a department; use float_department_create to add a new one.
Requires department_id, typically from float_departments_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `department_id` (`integer`, required): The department's id. Example: 123
- `name` (`string`, optional): The name of the department. Example: Engineers
- `parent_id` (`integer`, optional): The ID of this department's parent department (identifies this as a sub-department if not `null`) Example: 123

Example input: `{"department_id":123}`

### `float_logged_time_create`

Create Logged Time Entry · Write

Create a new logged time entry in your Float account. Logs actual hours worked by a person on a project.
Returns an array of loggedtime records with fields such as logged_time_id, people_id, date, reference_date, hours, billable, notes, project_id.
Use float_logged_time_create to add a new logged time entry; use float_logged_time_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Date of the logged time entry. Example: 2022-12-12
- `hours` (`number`, required): Total hours of the logged time entry, will be rounded to 2 decimal places, `0` values are valid however this acts as a soft-delete so the response is hidden. Example: 5.25
- `people_id` (`integer`, required): The ID of the person for the logged time entry. Example: 9876
- `project_id` (`integer`, required): The ID of the project on which this entry was logged. Example: 4567
- `notes` (`string`, optional): Additional notes about this logged time entry. Example: This took a lot longer than planned because I didn't have the original illustrations
- `phase_id` (`integer`, optional): The ID of the project phase for which this entry was logged. A value of `0` indicates no phase is used. Example: 335
- `reference_date` (`string`, optional): The date on which to suppress a log time suggestion of the corresponding `task_id` in the UI. Example: 2025-04-12
- `task_id` (`integer`, optional): The ID of a scheduled allocation, when used with `reference_date` it suppresses a matching log time suggestion in the UI. Example: 7654321
- `task_meta_id` (`integer`, optional): The ID of the associated project task (named for backwards compatibility), takes higher priority over `task_name`. Example: 1234567
- `task_name` (`string`, optional): The name of the project task against which this entry was logged, will create a project task name. Example: Front-end Development

Example input: `{"date":"<date>","hours":5.25,"people_id":9876,"project_id":4567}`

### `float_logged_time_update`

Update Logged Time Entry · Write

Update an existing logged time entry in your Float account; only the fields you provide are changed.
Returns the loggedtime record with fields such as logged_time_id, people_id, date, reference_date, hours, billable, notes, project_id.
Use float_logged_time_update to modify a logged time entry; use float_logged_time_create to add a new one.
Requires logged_time_id, typically from float_logged_times_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `logged_time_id` (`string`, required): Unique ID of the specific logged time entry to be updated. Example: 123
- `date` (`string`, optional): Date of the logged time entry. Example: 2022-12-12
- `hours` (`number`, optional): Total hours of the logged time entry, will be rounded to 2 decimal places, `0` values are valid however this acts as a soft-delete so the response is hidden. Example: 5.25
- `notes` (`string`, optional): Additional notes about this logged time entry. Example: This took a lot longer than planned because I didn't have the original illustrations
- `people_id` (`integer`, optional): The ID of the person for the logged time entry. Example: 9876
- `phase_id` (`integer`, optional): The ID of the project phase for which this entry was logged. A value of `0` indicates no phase is used. Example: 335
- `project_id` (`integer`, optional): The ID of the project on which this entry was logged. Example: 4567
- `reference_date` (`string`, optional): The date on which to suppress a log time suggestion of the corresponding `task_id` in the UI. Example: 2025-04-12
- `task_id` (`integer`, optional): The ID of a scheduled allocation, when used with `reference_date` it suppresses a matching log time suggestion in the UI. Example: 7654321
- `task_meta_id` (`integer`, optional): The ID of the associated project task (named for backwards compatibility), takes higher priority over `task_name`. Example: 1234567
- `task_name` (`string`, optional): The name of the project task against which this entry was logged, will create a project task name. Example: Front-end Development

Example input: `{"logged_time_id":"<logged_time_id>"}`

### `float_milestone_create`

Create Milestone · Write

Create a new milestone in your Float account.
Returns the record record with fields such as milestone_id, name, project_id, phase_id, date, end_date, created, modified.
Use float_milestone_create to add a new milestone; use float_milestone_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): Start date of the milestone. Example: 2019-12-01 09:00
- `name` (`string`, required): The name of the milestone. Example: Sprint #14
- `project_id` (`integer`, required): The project that this milestone belongs to. Example: 1
- `end_date` (`string`, optional): End date of the milestone if more than 1 day. Example: 2019-12-05 17:00
- `phase_id` (`integer`, optional): The phase that this milestone belongs to. Example: 1

Example input: `{"date":"<date>","name":"<name>","project_id":1}`

### `float_milestone_update`

Update Milestone · Write

Update an existing milestone in your Float account; only the fields you provide are changed.
Returns the record record with fields such as milestone_id, name, project_id, phase_id, date, end_date, created, modified.
Use float_milestone_update to modify a milestone; use float_milestone_create to add a new one.
Requires milestone_id, typically from float_milestones_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `milestone_id` (`integer`, required): The milestone's ID. Example: 123
- `date` (`string`, optional): Start date of the milestone. Example: 2019-12-01 09:00
- `end_date` (`string`, optional): End date of the milestone if more than 1 day. Example: 2019-12-05 17:00
- `name` (`string`, optional): The name of the milestone. Example: Sprint #14
- `phase_id` (`integer`, optional): The phase that this milestone belongs to. Example: 1
- `project_id` (`integer`, optional): The project that this milestone belongs to. Example: 1

Example input: `{"milestone_id":123}`

### `float_person_create`

Create Person · Write

Create a new person in your Float account. Creating a person does not create a sign-in account, and each active person uses a billing seat.
Returns the person record with fields such as people_id, name, people_code, email, job_title, role_id, department, notes.
Use float_person_create to add a new person; use float_person_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The person's full name. Example: Sarah-Jane Smith
- `active` (`integer`, optional): Is this person active or archived? `1` = Active, `0` = Archived. Archived people do not show on the schedule or contribute to billing seats and will have their access removed. Example: 1
- `auto_email` (`integer`, optional): Should this person's schedule be emailed at start of week? 1 = Yes, 0 = No. Example: 0
- `default_hourly_rate` (`string`, optional): Default hourly rate applied when the person is added to a fee-based project, the request also accepts a decimal `number`. Example: 100.50
- `department` (`object`, optional): The current department the person belongs to. Example: {}
- `email` (`string`, optional): Email address for this person. Example: sarahjane@example.com
- `employee_type` (`integer`, optional): Full-time or part-type. `1` = Full-time, `0` = Part-time. Example: 0
- `end_date` (`string`, optional): Date the person finished. Example: 2019-11-11
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `account`, `managers`, and `contracts`. Example: Expand
- `job_title` (`string`, optional): The name of the person's role as defined by their `role_id`. Example: Designer
- `notes` (`string`, optional): Any notes related to this person. Example: Sarah-Jane can't work on weekends.
- `people_code` (`string`, optional): An optional third-party identifier unique across all people enforced using case-insensitive comparison. Example: EMP-123456
- `people_type_id` (`integer`, optional): Is this person an `1` = Employee (default), `2` = Contractor, `3` = Placeholder, `4` = Role placeholder? Type `4` is not returned by default when listing people. Example: 1
- `region_id` (`integer`, optional): ID of the public holiday region to which the person belongs. Example: 1234
- `role_id` (`integer`, optional): ID of a role associated with this person, `role.name` is used for `job_title`, during updates `role_id` is higher order. Example: 0
- `start_date` (`string`, optional): Date the person started. Example: 2019-05-20
- `tags` (`array`, optional): Tags. Example: [1,2]
- `work_days_hours` (`array`, optional): Hours that a part-time person is available for scheduling each day in order from Sunday to Saturday. Example: [0,8,8,8,8,4,0]

Example input: `{"name":"<name>"}`

### `float_person_update`

Update Person · Write

Update an existing person in your Float account; only the fields you provide are changed. Setting active to 0 archives the person and revokes their account access.
Returns the person record with fields such as people_id, name, people_code, email, job_title, role_id, department, notes.
Use float_person_update to modify a person; use float_person_create to add a new one.
Requires people_id, typically from float_people_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `people_id` (`integer`, required): The person's id. Example: 123
- `active` (`integer`, optional): Is this person active or archived? `1` = Active, `0` = Archived. Archived people do not show on the schedule or contribute to billing seats and will have their access removed. Example: 1
- `auto_email` (`integer`, optional): Should this person's schedule be emailed at start of week? 1 = Yes, 0 = No. Example: 0
- `default_hourly_rate` (`string`, optional): Default hourly rate applied when the person is added to a fee-based project, the request also accepts a decimal `number`. Example: 100.50
- `department` (`object`, optional): The current department the person belongs to. Example: {}
- `email` (`string`, optional): Email address for this person. Example: sarahjane@example.com
- `employee_type` (`integer`, optional): Full-time or part-type. `1` = Full-time, `0` = Part-time. Example: 0
- `end_date` (`string`, optional): Date the person finished. Example: 2019-11-11
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `account`, `managers`, and `contracts`. Example: Expand
- `job_title` (`string`, optional): The name of the person's role as defined by their `role_id`. Example: Designer
- `name` (`string`, optional): The person's full name. Example: Sarah-Jane Smith
- `notes` (`string`, optional): Any notes related to this person. Example: Sarah-Jane can't work on weekends.
- `people_code` (`string`, optional): An optional third-party identifier unique across all people enforced using case-insensitive comparison. Example: EMP-123456
- `people_type_id` (`integer`, optional): Is this person an `1` = Employee (default), `2` = Contractor, `3` = Placeholder, `4` = Role placeholder? Type `4` is not returned by default when listing people. Example: 1
- `region_id` (`integer`, optional): ID of the public holiday region to which the person belongs. Example: 1234
- `role_id` (`integer`, optional): ID of a role associated with this person, `role.name` is used for `job_title`, during updates `role_id` is higher order. Example: 0
- `start_date` (`string`, optional): Date the person started. Example: 2019-05-20
- `tags` (`array`, optional): Tags. Example: [1,2]
- `work_days_hours` (`array`, optional): Hours that a part-time person is available for scheduling each day in order from Sunday to Saturday. Example: [0,8,8,8,8,4,0]

Example input: `{"people_id":123}`

### `float_phase_create`

Create Phase · Write

Create a new phase in your Float account.
Returns the phase record with fields such as phase_id, project_id, name, color, notes, start_date, end_date, budget_total.
Use float_phase_create to add a new phase; use float_phase_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): The end date of this phase which is either manually set or calculated from the latest milestone, allocation, or logged time within this phase. Example: 2025-02-23
- `name` (`string`, required): The name of the phase. Example: Design
- `project_id` (`integer`, required): The ID of the project to which this phase belongs. Example: 4567
- `start_date` (`string`, required): The start date of this phase which is either manually set or calculated from the earliest milestone, allocation, or logged time within this phase. Example: 2024-12-12
- `active` (`integer`, optional): Is this phase active or archived? `1` = Active, `0` = Archived. Example: 1
- `budget_total` (`number`, optional): The budget amount for 'hours by phase' or 'fee by phase' project budgets. Example: 1000.5
- `color` (`string`, optional): Phase's color in hexadecimal (defaults to project color) Example: 0095D7
- `default_hourly_rate` (`string`, optional): The default hourly rate for fee-based budgets, the request also accepts a decimal `number`. Example: 55.50
- `non_billable` (`integer`, optional): Is this phase billable? `0` = Billable, `1` = Non-billable. Example: 1
- `notes` (`string`, optional): Notes for this phase. Example: Due at the start of July. Paul to present
- `phase_team` (`array`, optional): `expand` field. A list of assignees on this phase by `people_id`, `role_id`, and `hourly_rate`, the list may be empty. Example: [1,2]
- `status` (`integer`, optional): The status of the phase `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Completed, `4` = Canceled. Draft phases can belong to a project of any status. Tentative phases must belong to tentative or confirmed projects. Confirmed, completed, and canceled phases must match their project's status. Example: 2
- `tentative` (`integer`, optional): (Deprecated - see `status`): Is this phase tentative? `1` = Yes, `0` = No. Example: 0

Example input: `{"end_date":"<end_date>","name":"<name>","project_id":4567,"start_date":"<start_date>"}`

### `float_phase_update`

Update Phase · Write

Update an existing phase in your Float account; only the fields you provide are changed.
Returns the phase record with fields such as phase_id, project_id, name, color, notes, start_date, end_date, budget_total.
Use float_phase_update to modify a phase; use float_phase_create to add a new one.
Requires phase_id, typically from float_phases_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phase_id` (`integer`, required): The phase's ID. Example: 123
- `active` (`integer`, optional): Is this phase active or archived? `1` = Active, `0` = Archived. Example: 1
- `budget_total` (`number`, optional): The budget amount for 'hours by phase' or 'fee by phase' project budgets. Example: 1000.5
- `color` (`string`, optional): Phase's color in hexadecimal (defaults to project color) Example: 0095D7
- `default_hourly_rate` (`string`, optional): The default hourly rate for fee-based budgets, the request also accepts a decimal `number`. Example: 55.50
- `end_date` (`string`, optional): The end date of this phase which is either manually set or calculated from the latest milestone, allocation, or logged time within this phase. Example: 2025-02-23
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `phase_tasks`, `phase_team`. Example: Expand
- `name` (`string`, optional): The name of the phase. Example: Design
- `non_billable` (`integer`, optional): Is this phase billable? `0` = Billable, `1` = Non-billable. Example: 1
- `notes` (`string`, optional): Notes for this phase. Example: Due at the start of July. Paul to present
- `phase_team` (`object`, optional): Manages the composition and details of the phase team. Example: {}
- `project_id` (`integer`, optional): The ID of the project to which this phase belongs. Example: 4567
- `start_date` (`string`, optional): The start date of this phase which is either manually set or calculated from the earliest milestone, allocation, or logged time within this phase. Example: 2024-12-12
- `status` (`integer`, optional): The status of the phase `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Completed, `4` = Canceled. Draft phases can belong to a project of any status. Tentative phases must belong to tentative or confirmed projects. Confirmed, completed, and canceled phases must match their project's status. Example: 2
- `tentative` (`integer`, optional): (Deprecated - see `status`): Is this phase tentative? `1` = Yes, `0` = No. Example: 0

Example input: `{"phase_id":123}`

### `float_project_create`

Create Project · Write

Create a new project in your Float account.
Returns the project record with fields such as project_id, name, project_code, client_id, color, notes, tags, budget_type.
Use float_project_create to add a new project; use float_project_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The name of the project. Example: Website Redesign
- `active` (`integer`, optional): Is this project active or archived? `1` = Active, `0` = Archived. Example: 1
- `all_pms_schedule` (`integer`, optional): Managers not assigned to the project team can edit this project. `1` = Yes, `0` = No. Example: 0
- `budget_per_phase` (`integer`, optional): (Deprecated - see `budget_priority`): Is the budget set per Phase? `1` = Yes, `0` = No. Example: 1
- `budget_priority` (`integer`, optional): Defines which level the budget will be determined from; `0` = Project, `1` = Phase, `2` = Task. For non-project levels, the total budget can be calculated from the sum of budgets in each Phase or Task. Example: 0
- `budget_total` (`number`, optional): The budget amount for Total hours or Total fee project budgets. Displays as `null` for Time & materials, Phase and Task budgets, also see `budget_priority`. Example: 1000.5
- `budget_type` (`integer`, optional): Is there a project budget? `1` = Total hours, `2` = Total fee, `3` = Time & materials. Example: 1
- `client_id` (`integer`, optional): The ID of the project's client. Example: 45672
- `color` (`string`, optional): Project's color in hexadecimal. Example: 0095D7
- `currency_code` (`string`, optional): `expand` field. The ISO 4217 currency code assigned to this project. Only returned when using `expand=currency`. Can be set via POST and PATCH; the value must correspond to a `target_currency` in the company's currencies list. Example: CAD
- `default_hourly_rate` (`string`, optional): The hourly rate applied to every person on the project team by using the 'Set same for everyone' billing rate option, for fee-based budgets. The request also accepts a decimal `number`. If `rate_card_id` is also set on the project, the rate card takes priority and this field is not used to determine bill rates. Example: 55.50
- `end_date` (`string`, optional): The end date of this project which is either manually set or calculated from the latest phase, milestone, allocation, or logged time. Example: 2025-01-18
- `expenses` (`array`, optional): `expand` field. The expenses assigned to this project. Example: [1,2]
- `fx_rate` (`number`, optional): `expand` field. The exchange rate applied to this project's currency. Only returned when using `expand=currency`. If omitted on POST or PATCH, the default `fx_rate` from the matching currency record is used. Example: 1.39
- `locked_task_list` (`integer`, optional): Are members locked from adding project tasks (Only Project Managers can add to this list)? 1 = Yes, locked to project editors, 0 = No, anyone can add tasks. Example: 1
- `non_billable` (`integer`, optional): Is this project billable? `0` = Billable, `1` = Non-billable. Example: 1
- `notes` (`string`, optional): Notes for this project. Example: Due at the start of July. Paul to present
- `phases` (`array`, optional): `expand` field. A list of phases on this project (`phase_id`, `name`, `color`, `budget`, `start_date`, `end_date`), the list may be empty. Example: [1,2]
- `project_code` (`string`, optional): An optional third-party identifier unique across all projects enforced using case-insensitive comparison. Example: PRJ-123456
- `project_manager` (`integer`, optional): The account ID of the project owner. Example: 17393464
- `project_tasks` (`array`, optional): `expand` field. A list of the project tasks available in this project. Example: [1,2]
- `project_team` (`array`, optional): `expand` field. A list of project-level team members by `people_id`, `role_id`, and `hourly_rate`. Only entries with `phase_id` = `0` are returned; for phase-specific roles and rates use `GET /phases?project_id=project_id` and add `expand=phase_team`. Example: [1,2]
- `rate_card_id` (`integer`, optional): The ID of the [rate card](/api_reference#Rate_Cards) applied to this project. Only supported for fee-based budgets (`budget_type` = `2` or `3`). When set, it determines the bill rate for each project team member based on their role, taking priority over `default_hourly_rate` and any per-person `hourly_rate` on `project_team`. Set to `null` to remove the rate card from the project. Example: 95020
- `stage_id` (`integer`, optional): The ID of the project stage for this project. This field takes precedence over `status` when both are provided. If omitted, the first available stage related to the project's `status` will be used. Example: 1
- `start_date` (`string`, optional): The start date of this project which is either manually set or calculated from the earliest phase, milestone, allocation, or logged time. Example: 2024-11-07
- `status` (`integer`, optional): The status of the project `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Completed, `4` = Canceled. If both `status` and `stage_id` are provided, `stage_id` takes precedence. If only `status` is provided, the first available stage for that status will be automatically selected. Example: 2
- `tags` (`array`, optional): List of tags. Example: ["digital","pitch"]
- `tentative` (`integer`, optional): (Deprecated - see `status`): Is this project tentative? `1` = Yes, `0` = No. Example: 0

Example input: `{"name":"<name>"}`

### `float_project_from_template_create`

Create Project From Template · Write

Create a new project in Float by copying an existing project template.
Returns the record record with fields such as .
Use float_project_from_template_create to start a project from a template; use float_project_create for a blank project.
Requires project_template_id, typically from float_project_templates_list, plus a project_code and start_date.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_code` (`string`, required): Required. A third-party identifier unique across all projects, enforced using case-insensitive comparison. Maximum length is 32 characters. Used to retrieve the created project via `GET /projects?project_code={project_code}` after the asynchronous create completes. Example: PRJ-123456
- `project_template_id` (`integer`, required): The project template's ID. Example: 123
- `start_date` (`string`, required): Required. The start date of the new project. Phases, milestones, expenses, and project tasks are scheduled relative to this date using each item's `parent_offset` and `duration` from the template. Example: 2026-07-01
- `active` (`integer`, optional): Is this project active or archived? `1` = Active, `0` = Archived. Example: 1
- `all_pms_schedule` (`integer`, optional): Managers not assigned to the project team can edit this project. `1` = Yes, `0` = No. Example: 0
- `budget_priority` (`integer`, optional): Defines which level the budget will be determined from; `0` = Project, `1` = Phase, `2` = Task. Overrides the template value when provided. Example: 0
- `budget_total` (`number`, optional): The budget amount for Total hours or Total fee project budgets. Displays as `null` for Time & materials, Phase and Task budgets, also see `budget_priority`. Overrides the template value when provided. Example: 1000.5
- `budget_type` (`integer`, optional): Is there a project budget? `1` = Total hours, `2` = Total fee, `3` = Time & materials. Overrides the template value when provided. Example: 3
- `client_id` (`integer`, optional): The ID of the project's client. Overrides the template value when provided. Example: 45672
- `color` (`string`, optional): Project's color in hexadecimal. Overrides the template value when provided. Example: 68DDFD
- `currency_code` (`string`, optional): The ISO 4217 currency code assigned to this project. The value must correspond to a `target_currency` in the company's currencies list. If provided, `fx_rate` is also required. See `expand=currency` on [projects](/api_reference#Projects) Example: USD
- `default_hourly_rate` (`string`, optional): The hourly rate applied to every person on the project team by using the 'Set same for everyone' billing rate option, for fee-based budgets. The request also accepts a decimal `number`. If a `rate_card_id` is applied to the project (inherited from the template or set explicitly in this request), the rate card takes priority and this field is not used to determine bill rates. Overrides the template value when provided. Example: 55.50
- `end_date` (`string`, optional): The end date of the new project. If omitted, calculated from `start_date` plus the template's `duration`. Example: 2026-09-30
- `fx_rate` (`string`, optional): The exchange rate applied to this project's currency. Required when `currency_code` is provided. Also accepts a decimal `number`. Example: 1
- `locked_task_list` (`integer`, optional): Are members locked from adding project tasks (Only Project Managers can add to this list)? 1 = Yes, locked to project editors, 0 = No, anyone can add tasks. Example: 1
- `name` (`string`, optional): The name of the project. If omitted, the template name is used. Example: Website Redesign
- `non_billable` (`integer`, optional): Is this project billable? `0` = Billable, `1` = Non-billable. Overrides the template value when provided. Example: 0
- `notes` (`string`, optional): Notes for this project. Overrides the template value when provided. Example: example
- `project_manager` (`integer`, optional): The account ID of the project owner. Example: 80851
- `rate_card_id` (`integer`, optional): The ID of the [rate card](/api_reference#Rate_Cards) applied to this project. Only supported for fee-based budgets (`budget_type` = `2` or `3`). When set, it determines the bill rate for each project team member based on their role, taking priority over `default_hourly_rate` and any per-person hourly rate inherited from the template. If omitted, the template's `rate_card_id` is inherited. Set to `null` to remove the rate card inherited from the template. Example: 95020
- `stage_id` (`integer`, optional): The ID of the project stage for this project. This field takes precedence over `status` when both are provided. If omitted, the first available stage related to the project's `status` will be used. Example: 101079
- `status` (`integer`, optional): The status of the project `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Completed, `4` = Canceled. If both `status` and `stage_id` are provided, `stage_id` takes precedence. If only `status` is provided, the first available stage for that status will be automatically selected. Example: 2
- `tags` (`array`, optional): List of tags. Overrides the template value when provided. Example: []

Example input: `{"project_code":"<project_code>","project_template_id":123,"start_date":"<start_date>"}`

### `float_project_task_create`

Create Project Task · Write

Create a new project task in your Float account.
Returns the project task record with fields such as task_meta_id, project_id, phase_id, task_name, billable, budget, count_tasks, count_logged_time.
Use float_project_task_create to add a new project task; use float_project_task_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`integer`, required): The ID of the project the project task belongs to. Example: 32154
- `task_name` (`string`, required): The name of the project task, an empty string is valid and is the default on the UI when a project task has not been chosen. Example: Design
- `billable` (`integer`, optional): `1` = Billable, `0` = Non-billable - Billable project tasks may not belong to non-billable projects or phases. Example: 1
- `budget` (`number`, optional): The budget amount for 'hours by task' or 'fee by task' project budgets. Example: 100.99
- `phase_id` (`integer`, optional): The ID of the phase the project task belongs to; `0` indicates it does not belong to a phase. Example: 123. Default: `0`.

Example input: `{"project_id":32154,"task_name":"<task_name>"}`

### `float_project_task_update`

Update Project Task · Write

Update an existing project task in your Float account; only the fields you provide are changed.
Returns the project task record with fields such as task_meta_id, project_id, phase_id, task_name, billable, budget, count_tasks, count_logged_time.
Use float_project_task_update to modify a project task; use float_project_task_create to add a new one.
Requires project_task_id, typically from float_project_tasks_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_task_id` (`integer`, required): The project tasks ID as described in the `task_meta_id` field. Example: 123
- `billable` (`integer`, optional): `1` = Billable, `0` = Non-billable - Billable project tasks may not belong to non-billable projects or phases. Example: 1
- `budget` (`number`, optional): The budget amount for 'hours by task' or 'fee by task' project budgets. Example: 100.99
- `phase_id` (`integer`, optional): The ID of the phase the project task belongs to; `0` indicates it does not belong to a phase. Example: 123. Default: `0`.
- `project_id` (`integer`, optional): The ID of the project the project task belongs to. Example: 32154
- `task_name` (`string`, optional): The name of the project task, an empty string is valid and is the default on the UI when a project task has not been chosen. Example: Design

Example input: `{"project_task_id":123}`

### `float_project_update`

Update Project · Write

Update an existing project in your Float account; only the fields you provide are changed.
Returns the project record with fields such as project_id, name, project_code, client_id, color, notes, tags, budget_type.
Use float_project_update to modify a project; use float_project_create to add a new one.
Requires project_id, typically from float_projects_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`integer`, required): The project's ID. Example: 123
- `active` (`integer`, optional): Is this project active or archived? `1` = Active, `0` = Archived. Example: 1
- `all_pms_schedule` (`integer`, optional): Managers not assigned to the project team can edit this project. `1` = Yes, `0` = No. Example: 0
- `budget_per_phase` (`integer`, optional): (Deprecated - see `budget_priority`): Is the budget set per Phase? `1` = Yes, `0` = No. Example: 1
- `budget_priority` (`integer`, optional): Defines which level the budget will be determined from; `0` = Project, `1` = Phase, `2` = Task. For non-project levels, the total budget can be calculated from the sum of budgets in each Phase or Task. Example: 0
- `budget_total` (`number`, optional): The budget amount for Total hours or Total fee project budgets. Displays as `null` for Time & materials, Phase and Task budgets, also see `budget_priority`. Example: 1000.5
- `budget_type` (`integer`, optional): Is there a project budget? `1` = Total hours, `2` = Total fee, `3` = Time & materials. Example: 1
- `client_id` (`integer`, optional): The ID of the project's client. Example: 45672
- `color` (`string`, optional): Project's color in hexadecimal. Example: 0095D7
- `currency_code` (`string`, optional): `expand` field. The ISO 4217 currency code assigned to this project. Only returned when using `expand=currency`. Can be set via POST and PATCH; the value must correspond to a `target_currency` in the company's currencies list. Example: CAD
- `default_hourly_rate` (`string`, optional): The hourly rate applied to every person on the project team by using the 'Set same for everyone' billing rate option, for fee-based budgets. The request also accepts a decimal `number`. If `rate_card_id` is also set on the project, the rate card takes priority and this field is not used to determine bill rates. Example: 55.50
- `end_date` (`string`, optional): The end date of this project which is either manually set or calculated from the latest phase, milestone, allocation, or logged time. Example: 2025-01-18
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `expenses`, `phases`, `project_tasks`, `project_team`, `currency`. Example: Expand
- `expenses` (`array`, optional): `expand` field. The expenses assigned to this project. Example: [1,2]
- `fx_rate` (`number`, optional): `expand` field. The exchange rate applied to this project's currency. Only returned when using `expand=currency`. If omitted on POST or PATCH, the default `fx_rate` from the matching currency record is used. Example: 1.39
- `locked_task_list` (`integer`, optional): Are members locked from adding project tasks (Only Project Managers can add to this list)? 1 = Yes, locked to project editors, 0 = No, anyone can add tasks. Example: 1
- `name` (`string`, optional): The name of the project. Example: Website Redesign
- `non_billable` (`integer`, optional): Is this project billable? `0` = Billable, `1` = Non-billable. Example: 1
- `notes` (`string`, optional): Notes for this project. Example: Due at the start of July. Paul to present
- `phases` (`array`, optional): `expand` field. A list of phases on this project (`phase_id`, `name`, `color`, `budget`, `start_date`, `end_date`), the list may be empty. Example: [1,2]
- `project_code` (`string`, optional): An optional third-party identifier unique across all projects enforced using case-insensitive comparison. Example: PRJ-123456
- `project_manager` (`integer`, optional): The account ID of the project owner. Example: 17393464
- `project_tasks` (`array`, optional): `expand` field. A list of the project tasks available in this project. Example: [1,2]
- `project_team` (`object`, optional): Manages the composition and details of the project team. Example: {}
- `rate_card_id` (`integer`, optional): The ID of the [rate card](/api_reference#Rate_Cards) applied to this project. Only supported for fee-based budgets (`budget_type` = `2` or `3`). When set, it determines the bill rate for each project team member based on their role, taking priority over `default_hourly_rate` and any per-person `hourly_rate` on `project_team`. Set to `null` to remove the rate card from the project. Example: 95020
- `stage_id` (`integer`, optional): The ID of the project stage for this project. This field takes precedence over `status` when both are provided. If omitted, the first available stage related to the project's `status` will be used. Example: 1
- `start_date` (`string`, optional): The start date of this project which is either manually set or calculated from the earliest phase, milestone, allocation, or logged time. Example: 2024-11-07
- `status` (`integer`, optional): The status of the project `0` = Draft, `1` = Tentative, `2` = Confirmed, `3` = Completed, `4` = Canceled. If both `status` and `stage_id` are provided, `stage_id` takes precedence. If only `status` is provided, the first available stage for that status will be automatically selected. Example: 2
- `tags` (`array`, optional): List of tags. Example: ["digital","pitch"]
- `tentative` (`integer`, optional): (Deprecated - see `status`): Is this project tentative? `1` = Yes, `0` = No. Example: 0

Example input: `{"project_id":123}`

### `float_role_create`

Create Role · Write

Create a new role in your Float account.
Returns the role record with fields such as id, name, default_hourly_rate, created, created_by, modified, modified_by, cost_rate_history.
Use float_role_create to add a new role; use float_role_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The name of the role. Example: Senior prompt engineer
- `cost_rate_history` (`array`, optional): `expand` field. List of cost rates applied to people with the role and the effective date when they apply from. Example: [1,2]
- `default_hourly_rate` (`string`, optional): Default hourly rate applied to a fee-based project/phase team member using this role. Example: 260.000
- `people_count` (`integer`, optional): `expand` field. Count of all people currently assigned to the role. Example: 4
- `people_ids` (`array`, optional): `expand` field. List of all people by `people_id` that are currently assigned to the role. Example: [1,2]

Example input: `{"name":"<name>"}`

### `float_role_update`

Update Role · Write

Update an existing role in your Float account; only the fields you provide are changed.
Returns the role record with fields such as id, name, default_hourly_rate, created, created_by, modified, modified_by, cost_rate_history.
Use float_role_update to modify a role; use float_role_create to add a new one.
Requires role_id, typically from float_roles_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `role_id` (`integer`, required): The role's ID. Example: 123
- `cost_rate_history` (`array`, optional): `expand` field. List of cost rates applied to people with the role and the effective date when they apply from. Example: [1,2]
- `default_hourly_rate` (`string`, optional): Default hourly rate applied to a fee-based project/phase team member using this role. Example: 260.000
- `expand` (`string`, optional): Comma-delimited values expands the response with additional fields: `cost_rate_history`, `people_ids`,`people_count`. Example: Expand
- `name` (`string`, optional): The name of the role. Example: Senior prompt engineer
- `people_count` (`integer`, optional): `expand` field. Count of all people currently assigned to the role. Example: 4
- `people_ids` (`array`, optional): `expand` field. List of all people by `people_id` that are currently assigned to the role. Example: [1,2]

Example input: `{"role_id":123}`

### `float_timeoff_create`

Create Time Off Entry · Write

Create a new time off entry in your Float account. Can book the same time off for several people at once.
Returns the timeoff record with fields such as timeoff_id, timeoff_type_id, start_date, end_date, start_time, hours, timeoff_notes, repeat_state.
Use float_timeoff_create to add a new time off entry; use float_timeoff_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): End date of this time off. Example: 2019-12-06
- `hours` (`number`, required): Number of hours per day for this time off. Not required when a full day. Example: 6.5
- `people_ids` (`array`, required): List of people IDs assigned to this time off. Example: ["23442","22321"]
- `start_date` (`string`, required): Start date of this time off. Example: 2019-11-16
- `timeoff_type_id` (`integer`, required): The ID of this time off type. Example: 1345
- `full_day` (`integer`, optional): Is this time off for a full day? `1` = Yes, `0` = No. Example: 1
- `repeat_end` (`string`, optional): Date that the repeating time off will cease. Example: 2019-03-16
- `repeat_state` (`integer`, optional): Frequency that this timeoff repeats. `0` = No repeat, `1` = Weekly, `2` = Monthly, `3` = Every two weeks, `4` = Every three weeks, `5` = Every six weeks, `6` = Every two months, `7` = Every three months, `8` = Every six months, `9` = Yearly. Example: 0
- `start_time` (`string`, optional): Start time of this time off in 24 hr format. Example: 14:00
- `status` (`integer`, optional): Status of the time off. `1` = Tentative, `2` = Confirmed. Example: 2
- `timeoff_notes` (`string`, optional): Additional notes about the time off. Example: example

Example input: `{"end_date":"<end_date>","hours":6.5,"people_ids":["23442","22321"],"start_date":"<start_date>","timeoff_type_id":1345}`

### `float_timeoff_update`

Update Time Off Entry · Write

Update an existing time off entry in your Float account; only the fields you provide are changed.
Returns the timeoff record with fields such as timeoff_id, timeoff_type_id, start_date, end_date, start_time, hours, timeoff_notes, repeat_state.
Use float_timeoff_update to modify a time off entry; use float_timeoff_create to add a new one.
Requires timeoff_id, typically from float_timeoffs_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `timeoff_id` (`integer`, required): The time off's ID. Example: 123
- `end_date` (`string`, optional): End date of this time off. Example: 2019-12-06
- `full_day` (`integer`, optional): Is this time off for a full day? `1` = Yes, `0` = No. Example: 1
- `hours` (`number`, optional): Number of hours per day for this time off. Not required when a full day. Example: 6.5
- `people_ids` (`array`, optional): List of people IDs assigned to this time off. Example: ["23442","22321"]
- `repeat_end` (`string`, optional): Date that the repeating time off will cease. Example: 2019-03-16
- `repeat_state` (`integer`, optional): Frequency that this timeoff repeats. `0` = No repeat, `1` = Weekly, `2` = Monthly, `3` = Every two weeks, `4` = Every three weeks, `5` = Every six weeks, `6` = Every two months, `7` = Every three months, `8` = Every six months, `9` = Yearly. Example: 0
- `start_date` (`string`, optional): Start date of this time off. Example: 2019-11-16
- `start_time` (`string`, optional): Start time of this time off in 24 hr format. Example: 14:00
- `status` (`integer`, optional): Status of the time off. `1` = Tentative, `2` = Confirmed. Example: 2
- `timeoff_notes` (`string`, optional): Additional notes about the time off. Example: example
- `timeoff_type_id` (`integer`, optional): The ID of this time off type. Example: 1345

Example input: `{"timeoff_id":123}`

### `float_allocation_delete`

Delete Allocation · Destructive

Delete a allocation from your Float account. This permanently removes the allocation.
Returns no content (HTTP 204) on success.
Use float_allocation_delete only to permanently remove a allocation; use float_allocation_update to change it instead.
Requires task_id, typically from float_allocations_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`integer`, required): The allocation as a task ID. Example: 123

Example input: `{"task_id":123}`

### `float_logged_time_delete`

Delete Logged Time Entry · Destructive

Delete a logged time entry from your Float account. This permanently removes the logged time entry.
Returns no content (HTTP 204) on success.
Use float_logged_time_delete only to permanently remove a logged time entry; use float_logged_time_update to change it instead.
Requires logged_time_id, typically from float_logged_times_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `logged_time_id` (`string`, required): Unique ID of the specific logged time entry to be deleted. Example: 123

Example input: `{"logged_time_id":"<logged_time_id>"}`

### `float_timeoff_delete`

Delete Time Off Entry · Destructive

Delete a time off entry from your Float account. This permanently removes the time off entry.
Returns no content (HTTP 204) on success.
Use float_timeoff_delete only to permanently remove a time off entry; use float_timeoff_update to change it instead.
Requires timeoff_id, typically from float_timeoffs_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `timeoff_id` (`integer`, required): time off id to delete. Example: 123

Example input: `{"timeoff_id":123}`

## Related

Other Project Management connectors ([all 67](/agentkit/connectors/?category=project-management)):

- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools
- [Airtable](/agentkit/connectors/airtable/): Scalekit connector, OAuth, 26 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
