Clockify

Learn how to use Clockify with Composio

Overview

Enum

CLOCKIFY

Description

Clockify is a free time tracking software that allows individuals and teams to track work hours across projects.

Authentication Details

api_key
stringRequired
client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
subdomain
stringRequired

Actions

This tool allows you to add one or more members to a specific project in clockify by updating memberships. it requires the workspace id, project id, and a list of member objects including user ids and their rates.

Action Parameters

memberships
arrayRequired
project_id
stringRequired
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

Creates a new client in a specified clockify workspace. this tool allows users to add new clients to their clockify account, which can then be associated with projects and time entries.

Action Parameters

address
string
email
string
name
stringRequired
note
string
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new project in a specified clockify workspace. it is essential for project management and time tracking in clockify and requires parameters such as workspaceid and name, with additional optional parameters like clientid, ispublic, billable, and color.

Action Parameters

billable
boolean
client_id
string
color
string
is_public
boolean
name
stringRequired
note
string
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new tag in a specified clockify workspace. tags are useful for categorizing and organizing time entries.

Action Parameters

name
stringRequired
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new task within a specified project in clockify. it requires a workspaceid, projectid, and task name, with an optional status parameter which defaults to ‘active’.

Action Parameters

assignee_ids
array
billable
boolean
estimate
string
name
stringRequired
project_id
stringRequired
status
stringDefaults to ACTIVE
user_group_ids
array
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new time entry in clockify with specified start and end times. it is different from real-time timer functionality as it allows for the creation of entries for past work or scheduling future tasks. it uses basic time entry details including description, start, end, and billable status.

Action Parameters

billable
boolean
description
string
end
stringRequired
project_id
string
start
stringRequired
tag_ids
array
task_id
string
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows users to find a client by name in a specified workspace in clockify. it searches through the list of clients and returns the matching client’s details. it requires a workspace id and a client name to perform a case-insensitive search, and optionally accepts an ‘archived’ flag to include archived clients.

Action Parameters

archived
boolean
name
string
page
integer
page_size
integer
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows users to find and retrieve information about projects in clockify. the tool searches for projects by name within a specified workspace and supports various filtering options. it retrieves project details such as project id, project name, client information, workspace information, project status, and other relevant project metadata.

Action Parameters

archived
boolean
billable
boolean
client_ids
array
client_status
string
contains_client
boolean
contains_user
boolean
hydrated
boolean
is_template
boolean
name
string
page
integerDefaults to 1
page_size
integerDefaults to 50
sort_column
string
sort_order
string
strict_name_search
boolean
user_ids
array
user_status
string
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows you to find a task by name within a specific project and workspace in clockify. it returns detailed information about the matching task including its id, name, status, and other properties.

Action Parameters

project_id
stringRequired
task_name
stringRequired
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows users to search and find time entries within a specified workspace. it can filter entries based on various criteria, including description, start datetime, end datetime, projectid, taskid, and tagids. the output is a list of time entries with details such as id, description, userid, billable status, projectid, timeinterval, workspaceid, tagids, and taskid.

Action Parameters

description
string
end_date
string
page
integerDefaults to 1
page_size
integerDefaults to 50
project_id
string
start_date
string
tagIds
array
task_id
string
user_id
string
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves all workspaces for the currently authenticated user. it provides essential workspace information needed for other api operations.

Action Parameters

Action Response

data
array
error
successful
boolean

This tool retrieves information about the currently authenticated user in clockify. it doesn’t require any additional parameters beyond authentication, and returns a json object with user details like id, name, email, and activeworkspace.

Action Parameters

Action Response

data
object
error
successful
boolean

This tool starts a new time entry in clockify and initiates a running timer. it accepts parameters such as description, billable, project name, task name, and tags, allowing for flexible configurations based on user inputs.

Action Parameters

billable
boolean
description
stringRequired
project_name
string
tags
array
task_name
string

Action Response

data
object
error
successful
boolean

This tool stops the currently running time entry for the authenticated user in the specified workspace. it automatically uses the given workspace id (which can be obtained from the ‘get all workspaces’ tool) and the current timestamp to stop the timer by calling the patch /workspaces/{workspaceid}/user/{userid}/time-entries endpoint.

Action Parameters

user_id
stringRequired
workspace_id
stringRequired

Action Response

data
object
error
successful
boolean