Skip to main content
Server path: /clockify-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
clockify_projects_add_users_cost_rateUpdate project user’s cost rate
clockify_projects_add_users_hourly_rateUpdate a project user’s billable rate
clockify_projects_add_users_to_projectAssign/remove users to/from the project
clockify_projects_create_clientAdd a new client
clockify_projects_create_new_projectAdd a new project
clockify_projects_create_new_tagAdd a new tag
clockify_projects_create_project_from_templateCreate project from a template
clockify_projects_create_taskAdd a new task on a project
clockify_projects_delete_clientDelete a client
clockify_projects_delete_projectDelete a project from a workspace
clockify_projects_delete_tagDelete a tag
clockify_projects_delete_taskDelete a task from a project
clockify_projects_get_clientGet a client by ID
clockify_projects_get_clientsFind clients on a workspace
clockify_projects_get_projectFind a project by ID
clockify_projects_get_projectsGet all projects on a workspace
clockify_projects_get_tagGet a tag by ID
clockify_projects_get_tagsFind tags on a workspace
clockify_projects_get_taskGet a task by id
clockify_projects_get_tasksFind tasks on a project
clockify_projects_set_task_cost_rateUpdate a task’s cost rate
clockify_projects_set_task_hourly_rateUpdate a task’s billable rate
clockify_projects_update_clientUpdate a client
clockify_projects_update_estimateUpdate project estimate
clockify_projects_update_is_project_templateUpdate a project template
clockify_projects_update_membershipsUpdate project memberships
clockify_projects_update_projectUpdate a project on a workspace
clockify_projects_update_tagUpdate a tag
clockify_projects_update_taskUpdate a task on a project

clockify_projects_add_users_cost_rate

Update project user’s cost rate Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
userIdstringYesRepresents a user identifier across the system.
amountintegerYesRepresents an amount as integer.
sincestringNoRepresents a date and time in yyyy-MM-ddThh:mm:ssZ format.

clockify_projects_add_users_hourly_rate

Update a project user’s billable rate Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
userIdstringYesRepresents a user identifier across the system.
amountintegerYesRepresents an amount as integer.
sincestringNoRepresents a date and time in yyyy-MM-ddThh:mm:ssZ format.

clockify_projects_add_users_to_project

Assign/remove users to/from the project Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
removebooleanNoSetting this flag to ‘true’ will remove the given users from the project.
userGroupsobjectNoProvide list with user group ids and corresponding status.
userIdsstring[]NoRepresents array of user ids which should be added/removed.

clockify_projects_create_client

Add a new client Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
addressstringNoRepresents a client’s address.
emailstringNoRepresents a client email.
namestringNoRepresents a client name.
notestringNoRepresents additional notes for the client.

clockify_projects_create_new_project

Add a new project Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
billablebooleanNoIndicates whether project is billable or not.
clientIdstringNoRepresents client identifier across the system.
colorstringNoColor format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with ’#’ and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.
costRateobjectNoCost Rate
estimateobjectNoRepresents an estimate request object.
hourlyRateobjectNoHourly Rate
isPublicbooleanNoIndicates whether project is public or not.
membershipsobject[]NoRepresents a list of membership request objects.
namestringYesRepresents a project name.
notestringNoRepresents project note.
tasksobject[]NoRepresents a list of task request objects.

clockify_projects_create_new_tag

Add a new tag Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoRepresents a tag name.

clockify_projects_create_project_from_template

Create project from a template Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
clientIdstringNoRepresents a client identifier across the system.
colorstringNoColor format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with ’#’ and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.
isPublicbooleanNoIndicates whether the project is public or not.
namestringYesRepresents a project name.
templateProjectIdstringYesRepresents a project identifier across the system.

clockify_projects_create_task

Add a new task on a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRepresents a project identifier across the system.
contains-assigneebooleanNoFlag to set whether task will have assignee or none.
workspaceIdstringYesRepresents a workspace identifier across the system.
assigneeIdstringNoAssignee Id
assigneeIdsstring[]NoRepresents list of assignee ids for the task.
budgetEstimateintegerNoRepresents a task budget estimate as long.
estimatestringNoRepresents a task duration estimate in ISO-8601 format.
idstringNoRepresents task identifier across the system.
namestringYesRepresents task name.
statusstringNoRepresents task status.
userGroupIdsstring[]NoRepresents list of user group ids for the task.

clockify_projects_delete_client

Delete a client Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a client identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_projects_delete_project

Delete a project from a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.

clockify_projects_delete_tag

Delete a tag Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a tag identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_projects_delete_task

Delete a task from a project Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesRepresents a task identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.

clockify_projects_get_client

Get a client by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a client identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_projects_get_clients

Find clients on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoFilters client results that matches with the string provided in their client name.
sort-columnstringNoColumn name that will be used as criteria for sorting results.
sort-orderstringNoSorting mode
pageintegerNoPage number.
page-sizeintegerNoPage size.
archivedstringNoFilter whether to include archived clients or not.

clockify_projects_get_project

Find a project by ID Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
hydratedbooleanNoIf set to true, results will contain additional information about the project
custom-field-entity-typestringNoIf provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field entity type.
expense-limitintegerNoRepresents the maximum number of expenses to fetch.
expense-datestringNoIf provided, you will get expenses dated before the provided value in yyyy-MM-dd format.

clockify_projects_get_projects

Get all projects on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoIf provided, you’ll get a filtered list of projects that contains the provided string in the project name.
strict-name-searchbooleanNoFlag to toggle on/off strict search mode. When set to true, search by name will only return projects whose name exactly matches the string value given for the ‘name’ parameter. When set to false, results will also include projects whose name contain the string value, but could be longer than the string value itself. For example, if there is a project with the name ‘applications’, and the search value is ‘app’, setting strict-name-search to true will not return that project in the results, whereas setting it to false will.
archivedbooleanNoIf provided and set to true, you’ll only get archived projects. If omitted, you’ll get both archived and non-archived projects.
billablebooleanNoIf provided and set to true, you’ll only get billable projects. If omitted, you’ll get both billable and non-billable projects.
clientsstring[]NoIf provided, you’ll get a filtered list of projects that contain clients which match any of the provided ids.
contains-clientbooleanNoIf 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-statusstringNoFilters projects based on client status provided.
usersstring[]NoIf provided, you’ll get a filtered list of projects that contain users which match any of the provided ids.
contains-userbooleanNoIf 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 which match the provided id(s) in ‘users’ field.
user-statusstringNoFilters projects based on user status provided.
is-templatebooleanNoFilters projects based on whether they are used as a template or not.
sort-columnstringNoSorts the results by the given column/field.
sort-orderstringNoSorting mode.
hydratedbooleanNoIf set to true, results will contain additional information about the project.
pageintegerNoPage number.
page-sizeintegerNoPage size.
accessstringNoValid set of string(s). If provided, you’ll get a filtered list of projects that matches the provided access.
expense-limitintegerNoRepresents the maximum number of expenses to fetch.
expense-datestringNoIf provided, you will get expenses dated before the provided value in yyyy-MM-dd format.
userGroupsstring[]NoIf provided, you’ll get a filtered list of projects that contain groups which match any of the provided ids.
contains-groupbooleanNoIf set to true, you’ll get a filtered list of projects that contain groups which match the provided id(s) in ‘userGroups’ field. If set to false, you’ll get a filtered list of projects which do NOT contain groups which match the provided id(s) in ‘userGroups’ field.

clockify_projects_get_tag

Get a tag by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a tag identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_projects_get_tags

Find tags on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoIf provided, you’ll get a filtered list of tags that matches the provided string in their name.
strict-name-searchbooleanNoFlag to toggle on/off strict search mode. When set to true, search by name will only return tags whose name exactly matches the string value given for the ‘name’ parameter. When set to false, results will also include tags whose name contain the string value, but could be longer than the string value itself. For example, if there is a tag with the name ‘applications’, and the search value is ‘app’, setting strict-name-search to true will not return that tag in the results, whereas setting it to false will.
excluded-idsstringNoRepresents a list of excluded ids
sort-columnstringNoRepresents a column to be used as sorting criteria.
sort-orderstringNoRepresents a sorting mode.
pageintegerNoPage number.
page-sizeintegerNoPage size.
archivedbooleanNoFilters the result whether tags are archived or not.

clockify_projects_get_task

Get a task by id Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesRepresents a task identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_projects_get_tasks

Find tasks on a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRepresents a project identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoIf provided, you’ll get a filtered list of tasks that matches the provided string in their name.
strict-name-searchbooleanNoFlag to toggle on/off strict search mode. When set to true, search by name only will return tasks whose name exactly matches the string value given for the ‘name’ parameter. When set to false, results will also include tasks whose name contain the string value, but could be longer than the string value itself. For example, if there is a task with the name ‘applications’, and the search value is ‘app’, setting strict-name-search to true will not return that task in the results, whereas setting it to false will.
is-activebooleanNoFilters search results whether task is active or not.
pageintegerNoPage number.
page-sizeintegerNoPage size.
sort-columnstringNoRepresents the column as criteria for sorting tasks.
sort-orderstringNoSorting mode.

clockify_projects_set_task_cost_rate

Update a task’s cost rate Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRepresents a project identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
idstringYesRepresents a task identifier across the system.
amountintegerYesRepresents an amount as integer.
sincestringNoRepresents a date and time in yyyy-MM-ddThh:mm:ssZ format.

clockify_projects_set_task_hourly_rate

Update a task’s billable rate Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRepresents a project identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
idstringYesRepresents a task identifier across the system.
amountintegerYesRepresents an hourly rate amount as integer.
sincestringNoRepresents a date and time in yyyy-MM-ddThh:mm:ssZ format.

clockify_projects_update_client

Update a client Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a client identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
archive-projectsbooleanNoThe archive-projects value
mark-tasks-as-donebooleanNoThe mark-tasks-as-done value
addressstringNoRepresents a client’s address.
archivedbooleanNoIndicates if client will be archived or not.
ccEmailsstring[]NoCc Emails
currencyIdstringNoRepresents a currency identifier across the system.
emailstringNoRepresents a client email.
namestringNoRepresents a client name.
notestringNoRepresents additional notes for the client.

clockify_projects_update_estimate

Update project estimate Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
budgetEstimateobjectNoRepresents estimate with options request object.
estimateResetobjectNoRepresents estimate reset request object.
timeEstimateobjectNoRepresents project time estimate request object.

clockify_projects_update_is_project_template

Update a project template Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
isTemplatebooleanNoIndicates whether project is a template or not.

clockify_projects_update_memberships

Update project memberships Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
membershipsobject[]YesRepresents a list of users with id and rates request objects.
userGroupsobjectNoProvide list with user group ids and corresponding status.

clockify_projects_update_project

Update a project on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
archivedbooleanNoIndicates whether project is archived or not.
billablebooleanNoIndicates whether project is billable or not.
clientIdstringNoRepresents client identifier across the system.
colorstringNoColor format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with ’#’ and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.
costRateobjectNoCost Rate
hourlyRateobjectNoHourly Rate
isPublicbooleanNoIndicates whether project is public or not.
namestringNoRepresents a project name.
notestringNoRepresents project note.

clockify_projects_update_tag

Update a tag Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a tag identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
archivedbooleanNoIndicates whether a tag will be archived or not.
namestringNoRepresents a tag name.

clockify_projects_update_task

Update a task on a project Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesRepresents a task identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
contains-assigneebooleanNoFlag to set whether task will have assignee or none.
membership-statusstringNoRepresents a membership status.
assigneeIdstringNoAssignee Id
assigneeIdsstring[]NoRepresents list of assignee ids for the task.
billablebooleanNoIndicates whether a task is billable or not.
budgetEstimateintegerNoRepresents a task budget estimate as integer.
estimatestringNoRepresents a task duration estimate.
namestringYesRepresents task name.
statusstringNoRepresents task status.
userGroupIdsstring[]NoRepresents list of user group ids for the task.