# List Projects — Clockify

> List all projects in a Clockify workspace. See the documentation

- Key: `clockify-list-projects`
- Type: Action (Read-only)
- Version: 0.0.3
- App: Clockify (`clockify`) — https://pipedream.com/apps/clockify.md
- This page (HTML): https://pipedream.com/apps/clockify/actions/list-projects
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/clockify/actions/list-projects/list-projects.mjs

## Description

List all projects in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Project/operation/getProjects)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `workspaceId` | `string` | Yes | Identifier of a workspace Options are loaded from the connected account. |
| `name` | `string` | No | If provided, you'll get a filtered list of projects that contains the provided string in the project name |
| `strictNameSearch` | `boolean` | No | Flag to toggle on/off strict search mode |
| `archived` | `boolean` | No | If set to true, you'll only get archived projects |
| `billable` | `boolean` | No | If set to true, you'll only get billable projects |
| `clients` | `string[]` | No | Array of client identifiers Options are loaded from the connected account. |
| `containsClient` | `boolean` | No | 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. |
| `clientStatus` | `string` | No | Filters projects based on client status provided |
| `users` | `string[]` | No | Array of member/user identifiers Options are loaded from the connected account. |
| `containsUser` | `boolean` | No | 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. |
| `userStatus` | `string` | No | Filters projects based on user status provided |
| `isTemplate` | `boolean` | No | Filters projects based on whether they are used as a template or not |
| `sortColumn` | `string` | No | The column to sort the projects by |
| `sortOrder` | `string` | No | The order to sort the results by |
| `hydrated` | `boolean` | No | If set to true, you'll get a hydrated response with additional information |
| `access` | `string` | No | If provided, you'll get a filtered list of projects that matches the provided access |
| `page` | `integer` | No | The page number to return. Default is 1 |
| `pageSize` | `integer` | No | The number of results to return. Default is 100 |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "clockify",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "clockify-list-projects",
  arguments: {
    workspaceId: "Workspace",
    name: "Name",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "clockify-list-projects",
    "configured_props": {
      "clockify": { "authProvisionId": "apn_xxxxxxx" },
      "workspaceId": "Workspace",
      "name": "Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/clockify.md · All apps: https://pipedream.com/apps