/clockify-workspace | Type: Application | PCID required: Yes
Tools
clockify_workspace_add_user
Add users to a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userGroupId | string | Yes | — | Represents a user group identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
clockify_workspace_add_users
Add user to a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
send-email | string | Yes | — | Indicates whether to send an email when user is added to the workspace. |
email | string | Yes | — | Represents an email address of the user. |
clockify_workspace_create
Create custom fields on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents workspace identifier across the system. |
allowedValues | string[] | No | — | Represents a list of custom field’s allowed values. |
description | string | No | — | Represents custom field description. |
entityType | string | No | — | Represents custom field entity type |
name | string | Yes | — | Represents custom field name. |
onlyAdminCanEdit | boolean | No | — | Flag to set whether custom field is modifiable only by admin users. |
placeholder | string | No | — | Represents custom field placeholder value. |
status | string | No | — | Represents custom field status |
type | string | Yes | — | Represents custom field type. |
workspaceDefaultValue | object | No | — | Represents a custom field’s default value in the workspace.<li>if type = NUMBER, then value must be a number</li><li>if type = DROPDOWN_MULTIPLE, value must be a list</li><li>if type = CHECKBOX, value must be true/false</li><li>otherwise any string</li> |
clockify_workspace_create_policy
Create a time off policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
allowHalfDay | boolean | No | — | Indicates whether policy allows half days. |
allowNegativeBalance | boolean | No | — | Indicates whether policy allows negative balances. |
approve | object | Yes | — | Represents approval settings. |
archived | boolean | No | — | Indicates whether policy is archived. |
automaticAccrual | object | No | — | Provide automatic accrual settings. |
automaticTimeEntryCreation | object | No | — | Provides automatic time entry creation settings. |
color | string | No | — | Provide color in 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. |
everyoneIncludingNew | boolean | No | — | Indicates whether the policy is to be applied to future new users. |
hasExpiration | boolean | No | — | Indicates whether the policy balance should have expiration |
icon | string | No | — | Provide icon. |
name | string | Yes | — | Represents a name of new policy. |
negativeBalance | object | No | — | Provide the negative balance data you would like to use for updating the policy. |
timeUnit | string | No | — | Indicates time unit of the policy. |
userGroups | object | No | — | Provide list with user group ids and corresponding status. |
users | object | No | — | Provide list with user ids and corresponding status. |
clockify_workspace_create_user_group
Add a new group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | Represents a user group name. |
clockify_workspace_create_user_role
Give manager role to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
entityId | string | Yes | — | Represents an entity identifier across the system. |
role | string | Yes | — | Represents a valid role. |
sourceType | string | No | — | Optional field used to indicate that the target of the operation is a user group, in which case the value USER_GROUP should be used, alongside a valid user group ID for the entityId field. If omitted, a user ID should be used for the entityId field. |
clockify_workspace_create_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | Represents a webhook name. |
triggerSource | string[] | Yes | — | Represents a list of trigger sources. |
triggerSourceType | string | Yes | — | Represents a webhook event trigger source type. |
url | string | Yes | — | Represents a webhook target url. |
webhookEvent | string | Yes | — | Represents a webhook event type. |
clockify_workspace_create_workspace
Add a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Represents a workspace name. |
organizationId | string | No | — | Represents the Cake organization identifier across the system. |
clockify_workspace_delete
Delete a custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents workspace identifier across the system. |
customFieldId | string | Yes | — | Represents custom field identifier across the system. |
clockify_workspace_delete_policy
Delete a policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a policy identifier across the system. |
clockify_workspace_delete_user
Remove a user from a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userGroupId | string | Yes | — | Represents a user group identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
clockify_workspace_delete_user_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a user group identifier across the system. |
clockify_workspace_delete_user_role
Remove user’s manager role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
entityId | string | Yes | — | Represents an entity identifier across the system. |
role | string | Yes | — | Represents a valid role. |
sourceType | string | No | — | Optional field used to indicate that the target of the operation is a user group, in which case the value USER_GROUP should be used, alongside a valid user group ID for the entityId field. If omitted, a user ID should be used for the entityId field. |
clockify_workspace_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
webhookId | string | Yes | — | Represents a webhook identifier across the system. |
clockify_workspace_edit_custom_field
Update custom field on workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
customFieldId | string | Yes | — | Represents a custom field identifier across the system. |
allowedValues | string[] | No | — | Represents a list of custom field’s allowed values. |
description | string | No | — | Represents a custom field description. |
name | string | Yes | — | Represents a custom field name. |
onlyAdminCanEdit | boolean | No | — | Flag to set whether custom field is modifiable only by admin users. |
placeholder | string | No | — | Represents a custom field placeholder value. |
required | boolean | No | — | Flag to set whether custom field is mandatory or not. |
status | string | No | — | Represents a custom field status |
type | string | Yes | — | Represents a custom field type. |
workspaceDefaultValue | object | No | — | Represents a custom field’s default value in the workspace. |
clockify_workspace_edit_project_custom_field_default_value
Update custom field on a 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. |
customFieldId | string | Yes | — | Represents a custom field identifier across the system. |
defaultValue | object | No | — | Represents a custom field’s default value. |
status | string | No | — | Represents a custom field status. |
clockify_workspace_filter_users_of_workspace
Filter workspace users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
accountStatuses | string[] | No | — | If provided, you’ll get a filtered list of users with the corresponding account status filter. If not, this will only filter ACTIVE, PENDING_EMAIL_VERIFICATION, and NOT_REGISTERED Users. |
email | string | No | — | If provided, you’ll get a filtered list of users that contain the provided string in their email address. |
includeRoles | boolean | No | — | If you pass along includeRoles=true, you’ll get each user’s detailed manager role (including projects and members for whom they’re managers) |
memberships | string | No | — | If provided, you’ll get all users along with workspaces, groups, or projects they have access to. |
name | string | No | — | If provided, you’ll get a filtered list of users that contain the provided string in their name. |
page | integer | No | — | Page number. |
pageSize | integer | No | — | Page size. |
projectId | string | No | — | If provided, you’ll get a list of users that have access to the project. |
roles | string[] | No | — | If provided, you’ll get a filtered list of users that have any of the specified roles. Owners are counted as admins when filtering. |
sortColumn | string | No | — | Sorting criteria |
sortOrder | string | No | — | Sorting mode |
status | string | No | — | If provided, you’ll get a filtered list of users with the corresponding status. |
userGroups | string[] | No | — | If provided, you’ll get a list of users that belong to the specified user group IDs. |
clockify_workspace_find_policies_for_workspace
Get policies on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
page | string | No | — | Page number. |
page-size | integer | No | — | Page size. |
name | string | No | — | If provided, you’ll get a filtered list of policies that contain the provided string in their name. |
status | string | No | — | If provided, you’ll get a filtered list of policies with the corresponding status. |
sort-column | string | No | — | The sort-column value |
sort-order | string | No | — | The sort-order value |
clockify_workspace_generate_new_token
Generate a new token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
webhookId | string | Yes | — | Represents a webhook identifier across the system. |
clockify_workspace_get_addon_webhooks
Get all webhooks for addon on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
addonId | string | Yes | — | Represents an addon identifier across the system. |
clockify_workspace_get_custom_fields_of_project
Get custom fields on a 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. |
status | string | No | — | If provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field status. |
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. |
clockify_workspace_get_logged_user
Get currently logged-in user’s info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include-memberships | boolean | No | — | If set to true, memberships will be included. |
clockify_workspace_get_logs_for_webhook
Get logs for a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
webhookId | string | Yes | — | Represents a webhook identifier across the system. |
page | integer | No | — | Page number. |
size | integer | No | — | Page size. |
from | string | No | — | Represents date and time in yyyy-MM-ddThh:mm:ssZ format. If provided, results will include logs which occurred after this value. |
sortByNewest | boolean | No | — | If set to true, logs will be sorted with most recent first. |
status | string | No | — | Filters logs by status. |
to | string | No | — | Represents date and time in yyyy-MM-ddThh:mm:ssZ format. If provided, results will include logs which occurred before this value. |
clockify_workspace_get_managers_of_user
Find user’s team manager Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
sort-column | string | No | — | Sorting column criteria |
sort-order | string | No | — | Sorting mode |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
clockify_workspace_get_member_profile
Get a member’s profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
clockify_workspace_get_of_user
Get workspace info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
clockify_workspace_get_policy
Get a time off policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a policy identifier across the system. |
clockify_workspace_get_user_groups
Find all groups on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
project-id | string | No | — | If provided, you’ll get a filtered list of groups that matches the string provided in their project id. |
name | string | No | — | If provided, you’ll get a filtered list of groups that matches the string provided in their name. |
sort-column | string | No | — | Column to be used as the sorting criteria. |
sort-order | string | No | — | Sorting mode. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
includeTeamManagers | boolean | No | — | If provided, you’ll get a list of team managers assigned to this user group. |
clockify_workspace_get_users_of_workspace
Find all users on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
email | string | No | — | If provided, you’ll get a filtered list of users that contain the provided string in their email address. |
project-id | string | No | — | If provided, you’ll get a list of users that have access to the project. |
status | string | No | — | If provided, you’ll get a filtered list of users with the corresponding status. |
account-statuses | string | No | — | If provided, you’ll get a filtered list of users with the corresponding account status filter. If not, this will only filter ACTIVE, PENDING_EMAIL_VERIFICATION, and NOT_REGISTERED Users. |
name | string | No | — | If provided, you’ll get a filtered list of users that contain the provided string in their name |
sort-column | string | No | — | Sorting column criteria. Default value: EMAIL |
sort-order | string | No | — | Sorting mode. Default value: ASCENDING |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
memberships | string | No | — | If provided, you’ll get all users along with workspaces, groups, or projects they have access to. Default value is NONE. |
include-roles | string | Yes | — | If you pass along includeRoles=true, you’ll get each user’s detailed manager role (including projects and members which they manage) |
clockify_workspace_get_webhook
Get a specific webhook by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
webhookId | string | Yes | — | Represents a webhook identifier across the system. |
clockify_workspace_get_webhooks
Get all webhooks on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
type | string | No | — | Represents a webhook type. |
clockify_workspace_get_workspaces_of_user
Get all my workspaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roles | string | No | — | If provided, you’ll get a filtered list of workspaces where you have any of the specified roles. Owners are not counted as admins when filtering. |
clockify_workspace_of_workspace
Get custom fields 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 custom fields that contain the provided string in their name. |
status | string | No | — | If provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field status. |
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. |
clockify_workspace_remove_default_value_of_project
Remove custom field from a 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. |
customFieldId | string | Yes | — | Represents a custom field identifier across the system. |
clockify_workspace_set_cost_rate_for_user
Update a user’s cost rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace 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_workspace_set_hourly_rate_for_user
Update a user’s hourly rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user 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_workspace_set_workspace_cost_rate
Update workspace cost rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace 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_workspace_set_workspace_hourly_rate
Update workspace billable rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
amount | integer | Yes | — | Represents an amount as integer. |
currency | string | Yes | — | Represents a currency. |
since | string | No | — | Represents a date and time in yyyy-MM-ddThh:mm:ssZ format. |
clockify_workspace_update_member_profile_with_additional_data
Update a member’s profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
imageUrl | string | No | — | Represents an image url. A field that can only be updated for limited users. |
name | string | No | — | This body field is deprecated and can only be updated for limited users. Represents name of the user and can be changed on the CAKE.com Account profile page. |
removeProfileImage | boolean | No | — | Indicates whether to remove profile image or not. A field that can only be updated for limited users. |
userCustomFields | object[] | No | — | Represents a list of upsert user custom field objects. |
weekStart | string | No | — | Represents a day of the week. |
workCapacity | string | No | — | Represents work capacity as a time duration in the ISO-8601 format. For example, for a 7hr work day, input should be PT7H. |
workingDays | string | No | — | Represents a list of days of the week. |
clockify_workspace_update_policy
Update a policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a policy identifier across the system. |
allowHalfDay | boolean | Yes | — | Indicates whether policy allows half day. |
allowNegativeBalance | boolean | Yes | — | Indicates whether policy allows negative balance. |
approve | object | Yes | — | Represents approval settings. |
archived | boolean | Yes | — | Indicates whether policy is archived. |
automaticAccrual | object | No | — | Provide automatic accrual settings. |
automaticTimeEntryCreation | object | No | — | Provides automatic time entry creation settings. |
color | string | No | — | Provide color in 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. |
everyoneIncludingNew | boolean | Yes | — | Indicates whether the policy is shown to new users. |
hasExpiration | boolean | Yes | — | Indicates whether the policy has expiration. |
icon | string | No | — | Provide icon. |
name | string | Yes | — | Provide the name you would like to use for updating the policy. |
negativeBalance | object | No | — | Provide the negative balance data you would like to use for updating the policy. |
userGroups | object | Yes | — | Provide list with user group ids and corresponding status. |
users | object | Yes | — | Provide list with user ids and corresponding status. |
clockify_workspace_update_policy_status
Change a policy status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a policy identifier across the system. |
status | string | Yes | — | Provide the status you would like to use for changing the policy. |
clockify_workspace_update_user_group
Update a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Represents a user group identifier across the system. |
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | Represents a user group name. |
clockify_workspace_update_user_status
Update a user’s status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
status | string | Yes | — | Represents membership status. |
clockify_workspace_update_webhook
Update a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
webhookId | string | Yes | — | Represents a webhook identifier across the system. |
name | string | No | — | Represents a webhook name. |
triggerSource | string[] | Yes | — | Represents a list of trigger sources. |
triggerSourceType | string | Yes | — | Represents a webhook event trigger source type. |
url | string | Yes | — | Represents a workspace identifier across the system. |
webhookEvent | string | Yes | — | Represents a webhook event type. |
clockify_workspace_upload_image
Add a photo Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | Yes | — | Image to be uploaded |
clockify_workspace_upsert_user_custom_field_value
Update a user’s custom field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
customFieldId | string | Yes | — | Represents custom field identifier across the system. |
value | object | No | — | Represents custom field value. |

