Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Float

Scalekit connector
Open markdown

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.

Tools
70
What they doRead · write · destructive
44 · 23 · 344 read23 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

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

  4. Authorize a user and make your first call

    quickstart.mts
    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)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Float credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • float_account_getRetrieve a single account from your Float account by ID.Read-only

    Get Account

    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.

    Inputs

    account_idintegerrequired
    The account ID. Example: 123
    expandstring
    Use `people_id` to return an additional `people_id` field that can reference a record on `/people`, or `null` if a guest. Example: Expand
  • float_accounts_listList accounts in your Float account, with optional filters, sorting, and page-based pagination.Read-only

    List Accounts

    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.

    Inputs

    expandstring
    Use `people_id` to return an additional `people_id` field that can reference a record on `/people`, or `null` if a guest. Example: Expand
    pageinteger
    The page number of the page of results to return, default `1`.default 1
    per_pageinteger
    The number of items per page, max is `200`.default 50
  • float_allocation_getRetrieve a single allocation from your Float account by ID.Read-only

    Get Allocation

    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.

    Inputs

    task_idintegerrequired
    The allocation as a task ID. Example: 123
  • float_allocations_listList allocations in your Float account, with optional filters, sorting, and page-based pagination.Read-only

    List Allocations

    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.

    Inputs

    billableinteger
    Filter response on `0` = non-billable or `1` = billable. Example: 1
    client_idinteger
    A client ID associated with projects to filter the response on. Example: 123
    end_datestring
    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
    expandstring
    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
    fieldsstring
    Comma-delimited set of fields to include in the response. Example: name,email
    modified_sincestring
    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
    pageinteger
    The page number of the page of results to return, default `1`.default 1
    people_idinteger
    A people ID to filter the response on. Example: 123
    per_pageinteger
    The number of items per page, max is `200`.default 50
    phase_idinteger
    A phase ID associated with a project to filter the response on. Example: 123
    project_idinteger
    A project ID to filter the response on. Example: 123
    repeat_stateinteger
    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
    sortstring
    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_datestring
    Start of date range in format YYYY-MM-DD. Must be used together with `end_date`. Example: 2025-01-31
    statusinteger
    Filter response on the Status. `1` = Tentative, `2` = Confirmed, `3` = Complete" Example: 1
    task_meta_idinteger
    A project task ID to filter the response on. Example: 123
  • float_client_getRetrieve a single client from your Float account by ID.Read-only

    Get Client

    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.

    Inputs

    client_idintegerrequired
    The client's ID. Example: 123
  • float_clients_listList clients in your Float account, with optional filters, sorting, and page-based pagination.Read-only

    List Clients

    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.

    Inputs

    pageinteger
    The page number of the page of results to return, default `1`.default 1
    per_pageinteger
    The number of items per page, max is `200`.default 50
  • float_currencies_listList currencies in your Float account, with optional filters, sorting, and page-based pagination.Read-only

    List Currencies

    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.

    Inputs

    expandstring
    Comma-delimited values expands the response with additional fields: `fx_rates`. Example: Expand
    pageinteger
    The page number of the page of results to return, default `1`.default 1
    per_pageinteger
    The number of items per page, max is `200`.default 50
  • float_currency_getRetrieve a single currency from your Float account by ID.Read-only

    Get Currency

    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.

    Inputs

    currency_idintegerrequired
    The currency record's ID. Example: 123
    expandstring
    Comma-delimited values expands the response with additional fields: `fx_rates`. Example: Expand