Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Clockify

Scalekit connector
Open markdown

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

Tools
26
What they doRead · write · destructive
14 · 11 · 114 read11 write1 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 Clockify connection

    In AgentKit > Connections, create a Clockify 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 = 'clockify'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Clockify:', 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: 'clockify_current_user_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Clockify 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
  • clockify_client_getGet one Clockify client by ID.Read-only

    Get Client

    Get one Clockify client by ID. Returns the client's id, name, email, address, note, archived and currencyId. Use this when you have a client ID. Use clockify_client_list to find clients by name.

    Inputs

    client_idstringrequired
    ID of the client. Get it from clockify_client_list. Example: 64c2d3e4f5a6b7c8d9e0f1a2.
    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
  • clockify_client_listList clients in a Clockify workspace, optionally filtered by name or archived status.Read-only

    List Clients

    List clients in a Clockify workspace, optionally filtered by name or archived status. Returns an array of clients with id, name, email, address, note, archived and currencyId. Use this to find a client ID. Use clockify_client_get when you already have the ID.

    Inputs

    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
    archivedboolean
    Set to true for archived clients only, or false for active clients only. Example: false.
    namestring
    Only return clients whose name contains this text. Example: Acme.
    pageinteger
    Page number to return, starting at 1. Clockify returns 1 when omitted. Example: 2.
    page_sizeinteger
    Number of items per page. Clockify uses 50 when omitted. Example: 100.
    sort_columnstring
    Field to sort by. Clockify sorts by NAME when omitted. Example: NAME.
    sort_orderstring
    Sort direction: ASCENDING or DESCENDING. Example: ASCENDING.one of ASCENDINGDESCENDING
  • clockify_current_user_getGet the Clockify user that owns the connected API key.Read-only

    Get Current User

    Get the Clockify user that owns the connected API key. Returns the user's id, name, email, activeWorkspace, defaultWorkspace, status and settings (time zone, week start, date format). Use this first to find your own user ID (needed by clockify_time_entry_list and clockify_time_entry_stop) and your active workspace ID. Use clockify_workspace_user_list to look up other people.

    Inputs

    include_membershipsboolean
    Set to true to also return the user's workspace and project memberships. Example: true.
  • clockify_project_getGet one Clockify project by ID.Read-only

    Get Project

    Get one Clockify project by ID. Returns the project's id, name, clientId, color, billable, archived, public, note, hourlyRate, costRate, estimate, budgetEstimate and memberships. Use this when you have a project ID. Use clockify_project_list to find projects by name or client.

    Inputs

    project_idstringrequired
    ID of the project. Get it from clockify_project_list. Example: 64b1c2d3e4f5a6b7c8d9e0f1.
    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
    hydratedboolean
    Set to true to include extra details, such as the project's custom fields. Example: true.
  • clockify_project_listList projects in a Clockify workspace, optionally filtered by name, client, archived or billable status.Read-only

    List Projects

    List projects in a Clockify workspace, optionally filtered by name, client, archived or billable status. Returns an array of projects with id, name, clientId, clientName, color, billable, archived, public, hourlyRate, estimate and memberships. Use this to find a project ID or browse projects. Use clockify_project_get for one project's full details.

    Inputs

    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
    archivedboolean
    Set to true for archived projects only, or false for active projects only. Leave empty to get both. Example: false.
    billableboolean
    Set to true for billable projects only, or false for non-billable only. Leave empty to get both. Example: true.
    clientsarray
    Only return projects that belong to any of these clients. Get client IDs from clockify_client_list. Example: ["64c2d3e4f5a6b7c8d9e0f1a2"].
    hydratedboolean
    Set to true to include extra details on each project, such as its custom fields and full membership data. Example: true.
    namestring
    Only return projects whose name contains this text (or matches it exactly when strict_name_search is true). Example: Website redesign.
    pageinteger
    Page number to return, starting at 1. Clockify returns 1 when omitted. Example: 2.
    page_sizeinteger
    Number of items per page. Clockify uses 50 when omitted. Example: 100.
    sort_columnstring
    Field to sort by: ID, NAME, CLIENT_NAME, DURATION, BUDGET or PROGRESS. Example: NAME.one of IDNAMECLIENT_NAMEDURATIONBUDGETPROGRESS
    sort_orderstring
    Sort direction: ASCENDING or DESCENDING. Example: ASCENDING.one of ASCENDINGDESCENDING
    strict_name_searchboolean
    Set to true so name matches only projects with exactly that name. Example: true.
  • clockify_tag_getGet one Clockify tag by ID.Read-only

    Get Tag

    Get one Clockify tag by ID. Returns the tag's id, name, workspaceId and archived flag. Use this when you have a tag ID. Use clockify_tag_list to find tags by name.

    Inputs

    tag_idstringrequired
    ID of the tag. Get it from clockify_tag_list. Example: 64f5a6b7c8d9e0f1a2b3c4d5.
    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
  • clockify_tag_listList tags in a Clockify workspace, optionally filtered by name or archived status.Read-only

    List Tags

    List tags in a Clockify workspace, optionally filtered by name or archived status. Returns an array of tags with id, name, workspaceId and archived. Use this to find tag IDs to put on time entries. Use clockify_tag_get when you already have the ID.

    Inputs

    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.
    archivedboolean
    Set to true for archived tags only, or false for active tags only. Example: false.
    namestring
    Only return tags whose name contains this text (or matches it exactly when strict_name_search is true). Example: meeting.
    pageinteger
    Page number to return, starting at 1. Clockify returns 1 when omitted. Example: 2.
    page_sizeinteger
    Number of items per page. Clockify uses 50 when omitted. Example: 100.
    sort_columnstring
    Field to sort by: ID or NAME. Example: NAME.one of IDNAME
    sort_orderstring
    Sort direction: ASCENDING or DESCENDING. Example: ASCENDING.one of ASCENDINGDESCENDING
    strict_name_searchboolean
    Set to true so name matches only tags with exactly that name. Example: true.
  • clockify_task_getGet one task of a Clockify project by ID.Read-only

    Get Task

    Get one task of a Clockify project by ID. Returns the task's id, name, projectId, assigneeIds, estimate, status, billable, duration and rates. Use this when you have a task ID. Use clockify_task_list to find tasks in a project.

    Inputs

    project_idstringrequired
    ID of the project. Get it from clockify_project_list. Example: 64b1c2d3e4f5a6b7c8d9e0f1.
    task_idstringrequired
    ID of the task. Get it from clockify_task_list. Example: 64d3e4f5a6b7c8d9e0f1a2b3.
    workspace_idstringrequired
    ID of the Clockify workspace. Get it from clockify_workspace_list, or use activeWorkspace / defaultWorkspace from clockify_current_user_get. Example: 64a687e29ae1f428e7ebe303.