List Tasks 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 Tasks with the Clockify API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the List Tasks action
1. Connect your Clockify account
2. Select a Workspace
3. Select a Project
4. Optional- Configure Name
5. Optional- Configure Strict Name Search
6. Optional- Configure Is Active
7. Optional- Select a Sort Column
8. Optional- Select a Sort Order
9. Optional- Configure Page
10. Optional- Configure Page Size
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
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 Tasks on Clockify

Description:List all tasks in a Clockify project. [See the documentation](https://docs.clockify.me/#tag/Task/operation/getTasks)

Version:0.0.1

Key:clockify-list-tasks

View on GitHub

Code#

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

export default {
  key: "clockify-list-tasks",
  name: "List Tasks",
  description: "List all tasks in a Clockify project. [See the documentation](https://docs.clockify.me/#tag/Task/operation/getTasks)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    clockify,
    workspaceId: {
      propDefinition: [
        clockify,
        "workspaceId",
      ],
    },
    projectId: {
      propDefinition: [
        clockify,
        "projectId",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "If provided, you'll get a filtered list of tasks that contains the provided string in the task name",
      optional: true,
    },
    strictNameSearch: {
      propDefinition: [
        clockify,
        "strictNameSearch",
      ],
    },
    isActive: {
      type: "boolean",
      label: "Is Active",
      description: "Filters search results whether task is active or not",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "The column to sort the tasks by",
      optional: true,
      options: [
        "ID",
        "NAME",
      ],
    },
    sortOrder: {
      propDefinition: [
        clockify,
        "sortOrder",
      ],
    },
    page: {
      propDefinition: [
        clockify,
        "page",
      ],
    },
    pageSize: {
      propDefinition: [
        clockify,
        "pageSize",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.clockify.listTasks({
      $,
      workspaceId: this.workspaceId,
      projectId: this.projectId,
      params: {
        "name": this.name,
        "strict-name-search": this.strictNameSearch,
        "is-active": this.isActive,
        "sort-column": this.sortColumn,
        "sort-order": this.sortOrder,
        "page": this.page,
        "page-size": this.pageSize,
      },
    });

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

    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.

Label	Prop	Type	Description
Clockify	`clockify`	`app`	This component uses the Clockify app.
Workspace	`workspaceId`	`string`	Select a value from the drop down menu.
Project	`projectId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	If provided, you'll get a filtered list of tasks that contains the provided string in the task name
Strict Name Search	`strictNameSearch`	`boolean`	Flag to toggle on/off strict search mode
Is Active	`isActive`	`boolean`	Filters search results whether task is active or not
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`IDNAME`
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`ASCENDINGDESCENDING`
Page	`page`	`integer`	The page number to return. Default is `1`
Page Size	`pageSize`	`integer`	The number of results to return. Default is `100`