← Clockify

List Projects with Clockify API

Pipedream makes it easy to connect APIs for Clockify and 3,000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Projects with the Clockify API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to List Projects with the Clockify API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List Projects action
    1. Connect your Clockify account
    2. Select a Workspace
    3. Optional- Configure Name
    4. Optional- Configure Strict Name Search
    5. Optional- Configure Archived
    6. Optional- Configure Billable
    7. Optional- Select one or more Clients
    8. Optional- Configure Contains Client
    9. Optional- Select a Client Status
    10. Optional- Select one or more Users
    11. Optional- Configure Contains User
    12. Optional- Select a User Status
    13. Optional- Configure Is Template
    14. Optional- Select a Sort Column
    15. Optional- Select a Sort Order
    16. Optional- Configure Hydrated
    17. Optional- Select a Access
    18. Optional- Configure Page
    19. Optional- Configure Page Size
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Projects on Clockify
Description:List all projects in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Project/operation/getProjects)
Version:0.0.1
Key:clockify-list-projects

Code

import clockify from "../../clockify.app.mjs";

export default {
  key: "clockify-list-projects",
  name: "List Projects",
  description: "List all projects in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Project/operation/getProjects)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    clockify,
    workspaceId: {
      propDefinition: [
        clockify,
        "workspaceId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "If provided, you'll get a filtered list of projects that contains the provided string in the project name",
      optional: true,
    },
    strictNameSearch: {
      propDefinition: [
        clockify,
        "strictNameSearch",
      ],
    },
    archived: {
      type: "boolean",
      label: "Archived",
      description: "If set to `true`, you'll only get archived projects",
      optional: true,
    },
    billable: {
      type: "boolean",
      label: "Billable",
      description: "If set to `true`, you'll only get billable projects",
      optional: true,
    },
    clients: {
      propDefinition: [
        clockify,
        "clientId",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      type: "string[]",
      label: "Clients",
      description: "Array of client identifiers",
    },
    containsClient: {
      type: "boolean",
      label: "Contains Client",
      description: "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: true,
    },
    clientStatus: {
      type: "string",
      label: "Client Status",
      description: "Filters projects based on client status provided",
      optional: true,
      options: [
        "ACTIVE",
        "ARCHIVED",
        "ALL",
      ],
    },
    users: {
      propDefinition: [
        clockify,
        "memberIds",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      label: "Users",
      description: "Array of member/user identifiers",
      optional: true,
    },
    containsUser: {
      type: "boolean",
      label: "Contains User",
      description: "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: true,
    },
    userStatus: {
      type: "string",
      label: "User Status",
      description: "Filters projects based on user status provided",
      optional: true,
      options: [
        "PENDING",
        "ACTIVE",
        "DECLINED",
        "INACTIVE",
        "ALL",
      ],
    },
    isTemplate: {
      type: "boolean",
      label: "Is Template",
      description: "Filters projects based on whether they are used as a template or not",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "The column to sort the projects by",
      optional: true,
      options: [
        "ID",
        "NAME",
        "CLIENT_NAME",
        "DURATION",
        "BUDGET",
        "PROGRESS",
      ],
    },
    sortOrder: {
      propDefinition: [
        clockify,
        "sortOrder",
      ],
    },
    hydrated: {
      propDefinition: [
        clockify,
        "hydrated",
      ],
    },
    access: {
      type: "string",
      label: "Access",
      description: "If provided, you'll get a filtered list of projects that matches the provided access",
      optional: true,
      options: [
        "PUBLIC",
        "PRIVATE",
      ],
    },
    page: {
      propDefinition: [
        clockify,
        "page",
      ],
    },
    pageSize: {
      propDefinition: [
        clockify,
        "pageSize",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.clockify.listProjects({
      $,
      workspaceId: this.workspaceId,
      params: {
        "name": this.name,
        "strict-name-search": this.strictNameSearch,
        "archived": this.archived,
        "billable": this.billable,
        "clients": this.clients,
        "contains-client": this.containsClient,
        "client-status": this.clientStatus,
        "users": this.users,
        "contains-user": this.containsUser,
        "user-status": this.userStatus,
        "is-template": this.isTemplate,
        "sort-column": this.sortColumn,
        "sort-order": this.sortOrder,
        "hydrated": this.hydrated,
        "access": this.access,
        "page": this.page,
        "page-size": this.pageSize,
      },
    });

    $.export("$summary", `Successfully listed ${response.length} projects in the workspace`);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
ClockifyclockifyappThis component uses the Clockify app.
WorkspaceworkspaceIdstringSelect a value from the drop down menu.
Namenamestring

If provided, you'll get a filtered list of projects that contains the provided string in the project name

Strict Name SearchstrictNameSearchboolean

Flag to toggle on/off strict search mode

Archivedarchivedboolean

If set to true, you'll only get archived projects

Billablebillableboolean

If set to true, you'll only get billable projects

Clientsclientsstring[]Select a value from the drop down menu.
Contains ClientcontainsClientboolean

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.

Client StatusclientStatusstringSelect a value from the drop down menu:ACTIVEARCHIVEDALL
Usersusersstring[]Select a value from the drop down menu.
Contains UsercontainsUserboolean

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.

User StatususerStatusstringSelect a value from the drop down menu:PENDINGACTIVEDECLINEDINACTIVEALL
Is TemplateisTemplateboolean

Filters projects based on whether they are used as a template or not

Sort ColumnsortColumnstringSelect a value from the drop down menu:IDNAMECLIENT_NAMEDURATIONBUDGETPROGRESS
Sort OrdersortOrderstringSelect a value from the drop down menu:ASCENDINGDESCENDING
Hydratedhydratedboolean

If set to true, you'll get a hydrated response with additional information

AccessaccessstringSelect a value from the drop down menu:PUBLICPRIVATE
Pagepageinteger

The page number to return. Default is 1

Page SizepageSizeinteger

The number of results to return. Default is 100

Authentication

Clockify uses API keys for authentication. When you connect your Clockify account, Pipedream securely stores the keys so you can easily authenticate to Clockify APIs in both code and no-code steps.

About Clockify

100% Free Time Tracking Software

More Ways to Use Clockify

Actions

Add Members To Project with the Clockify API

Adds member(s) to a project in Clockify. See the documentation

 
Try it
Add Task To Project with the Clockify API

Adds a task to a project in Clockify. See the documentation

 
Try it
Create Project with the Clockify API

Creates a new project in Clockify. See the documentation

 
Try it
Get Time Entry Report with the Clockify API

Get a time entry report. See the documentation

 
Try it
List Tasks with the Clockify API

List all tasks in a Clockify project. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
3,000+
apps by most popular

Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Premium
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Premium
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Premium
Klaviyo unifies your data, channels, and AI agents in one platform—text, WhatsApp, email marketing, and more—driving growth with every interaction.
Zendesk
Zendesk
Premium
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
Premium
Beta
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.