View as Markdown
Clockify icon

Clockify ACTION

List Clients

List all clients in a Clockify workspace. Optionally filter by a substring of the client name or by archived status, and page through results with the page and page size inputs. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Clockify account once, then configure and run List Clients from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "clockify-list-clients",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clockify: { authProvisionId: "apn_xxxxxxx" },
    workspaceId: "Workspace",
    name: "Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Clients inputs
Property Type Description
workspaceId Workspace string
Identifier of a workspace
Required Dynamic
name Name string
If provided, you'll get a filtered list of clients that contains the provided string in the client name
Optional
archived Archived boolean
If set to true, you'll only get archived clients
Optional
page Page integer
The page number to return. Default is 1
Optional
pageSize Page Size integer
The number of results to return. Default is 100
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
clockify-list-clients
Version
0.0.2
App
Clockify
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes