/clockify-projects | Type: Application | PCID required: Yes
Tools
clockify_projects_add_users_cost_rate
Update project user’s cost rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
amount | integer | Yes | — | Represents an amount as integer. |
since | string | No | — | Represents 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
amount | integer | Yes | — | Represents an amount as integer. |
since | string | No | — | Represents 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
remove | boolean | No | — | Setting this flag to ‘true’ will remove the given users from the project. |
userGroups | object | No | — | Provide list with user group ids and corresponding status. |
userIds | string[] | No | — | Represents array of user ids which should be added/removed. |
clockify_projects_create_client
Add a new client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
address | string | No | — | Represents a client’s address. |
email | string | No | — | Represents a client email. |
name | string | No | — | Represents a client name. |
note | string | No | — | Represents additional notes for the client. |
clockify_projects_create_new_project
Add a new project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
billable | boolean | No | — | Indicates whether project is billable or not. |
clientId | string | No | — | Represents client identifier across the system. |
color | string | No | — | Color 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. |
costRate | object | No | — | Cost Rate |
estimate | object | No | — | Represents an estimate request object. |
hourlyRate | object | No | — | Hourly Rate |
isPublic | boolean | No | — | Indicates whether project is public or not. |
memberships | object[] | No | — | Represents a list of membership request objects. |
name | string | Yes | — | Represents a project name. |
note | string | No | — | Represents project note. |
tasks | object[] | No | — | Represents a list of task request objects. |
clockify_projects_create_new_tag
Add a new tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | Represents a tag name. |
clockify_projects_create_project_from_template
Create project from a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clientId | string | No | — | Represents a client identifier across the system. |
color | string | No | — | Color 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. |
isPublic | boolean | No | — | Indicates whether the project is public or not. |
name | string | Yes | — | Represents a project name. |
templateProjectId | string | Yes | — | Represents a project identifier across the system. |
clockify_projects_create_task
Add a new task on a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Represents a project identifier across the system. |
contains-assignee | boolean | No | — | Flag to set whether task will have assignee or none. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assigneeId | string | No | — | Assignee Id |
assigneeIds | string[] | No | — | Represents list of assignee ids for the task. |
budgetEstimate | integer | No | — | Represents a task budget estimate as long. |
estimate | string | No | — | Represents a task duration estimate in ISO-8601 format. |
id | string | No | — | Represents task identifier across the system. |
name | string | Yes | — | Represents task name. |
status | string | No | — | Represents task status. |
userGroupIds | string[] | No | — | Represents list of user group ids for the task. |
clockify_projects_delete_client
Delete a client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a client identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_projects_delete_project
Delete a project from a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
clockify_projects_delete_tag
Delete a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a tag identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_projects_delete_task
Delete a task from a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Represents a task identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
clockify_projects_get_client
Get a client by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a client identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_projects_get_clients
Find clients on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | Filters client results that matches with the string provided in their client name. |
sort-column | string | No | — | Column name that will be used as criteria for sorting results. |
sort-order | string | No | — | Sorting mode |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
archived | string | No | — | Filter whether to include archived clients or not. |
clockify_projects_get_project
Find a project by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
hydrated | boolean | No | — | If set to true, results will contain additional information about the project |
custom-field-entity-type | string | No | — | If provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field entity type. |
expense-limit | integer | No | — | Represents the maximum number of expenses to fetch. |
expense-date | string | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | If provided, you’ll get a filtered list of projects that contains the provided string in the project name. |
strict-name-search | boolean | No | — | Flag 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. |
archived | boolean | No | — | If provided and set to true, you’ll only get archived projects. If omitted, you’ll get both archived and non-archived projects. |
billable | boolean | No | — | If provided and set to true, you’ll only get billable projects. If omitted, you’ll get both billable and non-billable projects. |
clients | string[] | No | — | If provided, you’ll get a filtered list of projects that contain clients which match any of the provided ids. |
contains-client | boolean | No | — | 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-status | string | No | — | Filters projects based on client status provided. |
users | string[] | No | — | If provided, you’ll get a filtered list of projects that contain users which match any of the provided ids. |
contains-user | boolean | No | — | 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 which match the provided id(s) in ‘users’ field. |
user-status | string | No | — | Filters projects based on user status provided. |
is-template | boolean | No | — | Filters projects based on whether they are used as a template or not. |
sort-column | string | No | — | Sorts the results by the given column/field. |
sort-order | string | No | — | Sorting mode. |
hydrated | boolean | No | — | If set to true, results will contain additional information about the project. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
access | string | No | — | Valid set of string(s). If provided, you’ll get a filtered list of projects that matches the provided access. |
expense-limit | integer | No | — | Represents the maximum number of expenses to fetch. |
expense-date | string | No | — | If provided, you will get expenses dated before the provided value in yyyy-MM-dd format. |
userGroups | string[] | No | — | If provided, you’ll get a filtered list of projects that contain groups which match any of the provided ids. |
contains-group | boolean | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a tag identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_projects_get_tags
Find tags on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | If provided, you’ll get a filtered list of tags that matches the provided string in their name. |
strict-name-search | boolean | No | — | Flag 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-ids | string | No | — | Represents a list of excluded ids |
sort-column | string | No | — | Represents a column to be used as sorting criteria. |
sort-order | string | No | — | Represents a sorting mode. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
archived | boolean | No | — | Filters the result whether tags are archived or not. |
clockify_projects_get_task
Get a task by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Represents a task identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_projects_get_tasks
Find tasks on a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Represents a project identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | If provided, you’ll get a filtered list of tasks that matches the provided string in their name. |
strict-name-search | boolean | No | — | Flag 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-active | boolean | No | — | Filters search results whether task is active or not. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
sort-column | string | No | — | Represents the column as criteria for sorting tasks. |
sort-order | string | No | — | Sorting mode. |
clockify_projects_set_task_cost_rate
Update a task’s cost rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Represents a project identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a task identifier across the system. |
amount | integer | Yes | — | Represents an amount as integer. |
since | string | No | — | Represents a date and time in yyyy-MM-ddThh:mm:ssZ format. |
clockify_projects_set_task_hourly_rate
Update a task’s billable rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Represents a project identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a task identifier across the system. |
amount | integer | Yes | — | Represents an hourly rate amount as integer. |
since | string | No | — | Represents a date and time in yyyy-MM-ddThh:mm:ssZ format. |
clockify_projects_update_client
Update a client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a client identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
archive-projects | boolean | No | — | The archive-projects value |
mark-tasks-as-done | boolean | No | — | The mark-tasks-as-done value |
address | string | No | — | Represents a client’s address. |
archived | boolean | No | — | Indicates if client will be archived or not. |
ccEmails | string[] | No | — | Cc Emails |
currencyId | string | No | — | Represents a currency identifier across the system. |
email | string | No | — | Represents a client email. |
name | string | No | — | Represents a client name. |
note | string | No | — | Represents additional notes for the client. |
clockify_projects_update_estimate
Update project estimate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
budgetEstimate | object | No | — | Represents estimate with options request object. |
estimateReset | object | No | — | Represents estimate reset request object. |
timeEstimate | object | No | — | Represents project time estimate request object. |
clockify_projects_update_is_project_template
Update a project template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
isTemplate | boolean | No | — | Indicates whether project is a template or not. |
clockify_projects_update_memberships
Update project memberships Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
memberships | object[] | Yes | — | Represents a list of users with id and rates request objects. |
userGroups | object | No | — | Provide list with user group ids and corresponding status. |
clockify_projects_update_project
Update a project on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
archived | boolean | No | — | Indicates whether project is archived or not. |
billable | boolean | No | — | Indicates whether project is billable or not. |
clientId | string | No | — | Represents client identifier across the system. |
color | string | No | — | Color 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. |
costRate | object | No | — | Cost Rate |
hourlyRate | object | No | — | Hourly Rate |
isPublic | boolean | No | — | Indicates whether project is public or not. |
name | string | No | — | Represents a project name. |
note | string | No | — | Represents project note. |
clockify_projects_update_tag
Update a tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a tag identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
archived | boolean | No | — | Indicates whether a tag will be archived or not. |
name | string | No | — | Represents a tag name. |
clockify_projects_update_task
Update a task on a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Represents a task identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
projectId | string | Yes | — | Represents a project identifier across the system. |
contains-assignee | boolean | No | — | Flag to set whether task will have assignee or none. |
membership-status | string | No | — | Represents a membership status. |
assigneeId | string | No | — | Assignee Id |
assigneeIds | string[] | No | — | Represents list of assignee ids for the task. |
billable | boolean | No | — | Indicates whether a task is billable or not. |
budgetEstimate | integer | No | — | Represents a task budget estimate as integer. |
estimate | string | No | — | Represents a task duration estimate. |
name | string | Yes | — | Represents task name. |
status | string | No | — | Represents task status. |
userGroupIds | string[] | No | — | Represents list of user group ids for the task. |

