List Time Entries 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 Time Entries 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 Time Entries with the Clockify API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Time Entries action
1. Connect your Clockify account
2. Select a Workspace
3. Select a User
4. Optional- Configure Description
5. Optional- Configure Start
6. Optional- Configure End
7. Optional- Select a Project
8. Optional- Select a Task
9. Optional- Select one or more Tags
10. Optional- Configure Project Required
11. Optional- Configure Task Required
12. Optional- Configure Hydrated
13. Optional- Configure In Progress
14. Optional- Configure Page
15. 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 Time Entries on Clockify

Description:List all time entries in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Time-entry/operation/getTimeEntries)

Version:0.0.1

Key:clockify-list-time-entries

View on GitHub

Code#

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

export default {
  key: "clockify-list-time-entries",
  name: "List Time Entries",
  description: "List all time entries in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Time-entry/operation/getTimeEntries)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    clockify,
    workspaceId: {
      propDefinition: [
        clockify,
        "workspaceId",
      ],
    },
    userId: {
      propDefinition: [
        clockify,
        "memberIds",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      type: "string",
      label: "User",
      description: "Identifier of a user",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Represents term for searching time entries by description",
      optional: true,
    },
    start: {
      type: "string",
      label: "Start",
      description: "Represents start date in yyyy-MM-ddThh:mm:ssZ format. Example: `2020-01-01T00:00:00Z`",
      optional: true,
    },
    end: {
      type: "string",
      label: "End",
      description: "Represents end date in yyyy-MM-ddThh:mm:ssZ format. Example: `2020-01-01T00:00:00Z`",
      optional: true,
    },
    projectId: {
      propDefinition: [
        clockify,
        "projectId",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      optional: true,
    },
    taskId: {
      propDefinition: [
        clockify,
        "taskId",
        (c) => ({
          workspaceId: c.workspaceId,
          projectId: c.projectId,
        }),
      ],
      optional: true,
    },
    tagIds: {
      propDefinition: [
        clockify,
        "tagIds",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      optional: true,
    },
    projectRequired: {
      type: "boolean",
      label: "Project Required",
      description: "Flag to set whether to only get time entries which have a project",
      optional: true,
    },
    taskRequired: {
      type: "boolean",
      label: "Task Required",
      description: "Flag to set whether to only get time entries which have a task",
      optional: true,
    },
    hydrated: {
      propDefinition: [
        clockify,
        "hydrated",
      ],
    },
    inProgress: {
      type: "boolean",
      label: "In Progress",
      description: "Flag to set whether to filter only in progress time entries",
      optional: true,
    },
    page: {
      propDefinition: [
        clockify,
        "page",
      ],
    },
    pageSize: {
      propDefinition: [
        clockify,
        "pageSize",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.clockify.listTimeEntries({
      $,
      workspaceId: this.workspaceId,
      userId: this.userId,
      params: {
        "description": this.description,
        "start": this.start,
        "end": this.end,
        "project": this.projectId,
        "task": this.taskId,
        "tags": this.tagIds,
        "project-required": this.projectRequired,
        "task-required": this.taskRequired,
        "hydrated": this.hydrated,
        "in-progress": this.inProgress,
        "page": this.page,
        "page-size": this.pageSize,
      },
    });

    $.export("$summary", `Successfully listed ${response.length} time entries`);

    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.
User	`userId`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Represents term for searching time entries by description
Start	`start`	`string`	Represents start date in yyyy-MM-ddThh:mm:ssZ format. Example: `2020-01-01T00:00:00Z`
End	`end`	`string`	Represents end date in yyyy-MM-ddThh:mm:ssZ format. Example: `2020-01-01T00:00:00Z`
Project	`projectId`	`string`	Select a value from the drop down menu.
Task	`taskId`	`string`	Select a value from the drop down menu.
Tags	`tagIds`	`string[]`	Select a value from the drop down menu.
Project Required	`projectRequired`	`boolean`	Flag to set whether to only get time entries which have a project
Task Required	`taskRequired`	`boolean`	Flag to set whether to only get time entries which have a task
Hydrated	`hydrated`	`boolean`	If set to `true`, you'll get a hydrated response with additional information
In Progress	`inProgress`	`boolean`	Flag to set whether to filter only in progress time entries
Page	`page`	`integer`	The page number to return. Default is `1`
Page Size	`pageSize`	`integer`	The number of results to return. Default is `100`