View as Markdown
Clockify icon

Clockify ACTION

List Projects

List all projects in a Clockify workspace. 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 Projects 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-projects",
  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 Projects 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 projects that contains the provided string in the project name
Optional
strictNameSearch Strict Name Search boolean
Flag to toggle on/off strict search mode
Optional
archived Archived boolean
If set to true, you'll only get archived projects
Optional
billable Billable boolean
If set to true, you'll only get billable projects
Optional
clients Clients string[]
Array of client identifiers
Optional Dynamic
containsClient Contains Client boolean
If set to true, you'll get a filtered list of projects that contain clients which match the provided id(s) in 'clients' field. If set to false, you'll get a filtered list of projects which do NOT contain clients that match the provided id(s) in 'clients' field.
Optional
clientStatus Client Status string
Filters projects based on client status provided
Optional
users Users string[]
Array of member/user identifiers
Optional Dynamic
containsUser Contains User boolean
If set to true, you'll get a filtered list of projects that contain users which match the provided id(s) in 'users' field. If set to false, you'll get a filtered list of projects which do NOT contain users that match the provided id(s) in 'users' field.
Optional
userStatus User Status string
Filters projects based on user status provided
Optional
isTemplate Is Template boolean
Filters projects based on whether they are used as a template or not
Optional
sortColumn Sort Column string
The column to sort the projects by
Optional
sortOrder Sort Order string
The order to sort the results by
Optional
hydrated Hydrated boolean
If set to true, you'll get a hydrated response with additional information
Optional
access Access string
If provided, you'll get a filtered list of projects that matches the provided access
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-projects
Version
0.0.3
App
Clockify
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes