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

Tools

ToolDescription
clockify_workspace_add_userAdd users to a group
clockify_workspace_add_usersAdd user to a workspace
clockify_workspace_createCreate custom fields on a workspace
clockify_workspace_create_policyCreate a time off policy
clockify_workspace_create_user_groupAdd a new group
clockify_workspace_create_user_roleGive manager role to a user
clockify_workspace_create_webhookCreate a webhook
clockify_workspace_create_workspaceAdd a workspace
clockify_workspace_deleteDelete a custom field
clockify_workspace_delete_policyDelete a policy
clockify_workspace_delete_userRemove a user from a group
clockify_workspace_delete_user_groupDelete a group
clockify_workspace_delete_user_roleRemove user’s manager role
clockify_workspace_delete_webhookDelete a webhook
clockify_workspace_edit_custom_fieldUpdate custom field on workspace
clockify_workspace_edit_project_custom_field_default_valueUpdate custom field on a project
clockify_workspace_filter_users_of_workspaceFilter workspace users
clockify_workspace_find_policies_for_workspaceGet policies on a workspace
clockify_workspace_generate_new_tokenGenerate a new token
clockify_workspace_get_addon_webhooksGet all webhooks for addon on a workspace
clockify_workspace_get_custom_fields_of_projectGet custom fields on a project
clockify_workspace_get_logged_userGet currently logged-in user’s info
clockify_workspace_get_logs_for_webhookGet logs for a webhook
clockify_workspace_get_managers_of_userFind user’s team manager
clockify_workspace_get_member_profileGet a member’s profile
clockify_workspace_get_of_userGet workspace info
clockify_workspace_get_policyGet a time off policy
clockify_workspace_get_user_groupsFind all groups on a workspace
clockify_workspace_get_users_of_workspaceFind all users on a workspace
clockify_workspace_get_webhookGet a specific webhook by id
clockify_workspace_get_webhooksGet all webhooks on a workspace
clockify_workspace_get_workspaces_of_userGet all my workspaces
clockify_workspace_of_workspaceGet custom fields on a workspace
clockify_workspace_remove_default_value_of_projectRemove custom field from a project
clockify_workspace_set_cost_rate_for_userUpdate a user’s cost rate
clockify_workspace_set_hourly_rate_for_userUpdate a user’s hourly rate
clockify_workspace_set_workspace_cost_rateUpdate workspace cost rate
clockify_workspace_set_workspace_hourly_rateUpdate workspace billable rate
clockify_workspace_update_member_profile_with_additional_dataUpdate a member’s profile
clockify_workspace_update_policyUpdate a policy
clockify_workspace_update_policy_statusChange a policy status
clockify_workspace_update_user_groupUpdate a group
clockify_workspace_update_user_statusUpdate a user’s status
clockify_workspace_update_webhookUpdate a webhook
clockify_workspace_upload_imageAdd a photo
clockify_workspace_upsert_user_custom_field_valueUpdate a user’s custom field

clockify_workspace_add_user

Add users to a group Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userGroupIdstringYesRepresents a user group identifier across the system.
userIdstringYesRepresents a user identifier across the system.

clockify_workspace_add_users

Add user to a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
send-emailstringYesIndicates whether to send an email when user is added to the workspace.
emailstringYesRepresents an email address of the user.

clockify_workspace_create

Create custom fields on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents workspace identifier across the system.
allowedValuesstring[]NoRepresents a list of custom field’s allowed values.
descriptionstringNoRepresents custom field description.
entityTypestringNoRepresents custom field entity type
namestringYesRepresents custom field name.
onlyAdminCanEditbooleanNoFlag to set whether custom field is modifiable only by admin users.
placeholderstringNoRepresents custom field placeholder value.
statusstringNoRepresents custom field status
typestringYesRepresents custom field type.
workspaceDefaultValueobjectNoRepresents 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
allowHalfDaybooleanNoIndicates whether policy allows half days.
allowNegativeBalancebooleanNoIndicates whether policy allows negative balances.
approveobjectYesRepresents approval settings.
archivedbooleanNoIndicates whether policy is archived.
automaticAccrualobjectNoProvide automatic accrual settings.
automaticTimeEntryCreationobjectNoProvides automatic time entry creation settings.
colorstringNoProvide 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.
everyoneIncludingNewbooleanNoIndicates whether the policy is to be applied to future new users.
hasExpirationbooleanNoIndicates whether the policy balance should have expiration
iconstringNoProvide icon.
namestringYesRepresents a name of new policy.
negativeBalanceobjectNoProvide the negative balance data you would like to use for updating the policy.
timeUnitstringNoIndicates time unit of the policy.
userGroupsobjectNoProvide list with user group ids and corresponding status.
usersobjectNoProvide list with user ids and corresponding status.

clockify_workspace_create_user_group

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

clockify_workspace_create_user_role

Give manager role to a user Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
entityIdstringYesRepresents an entity identifier across the system.
rolestringYesRepresents a valid role.
sourceTypestringNoOptional 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoRepresents a webhook name.
triggerSourcestring[]YesRepresents a list of trigger sources.
triggerSourceTypestringYesRepresents a webhook event trigger source type.
urlstringYesRepresents a webhook target url.
webhookEventstringYesRepresents a webhook event type.

clockify_workspace_create_workspace

Add a workspace Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoRepresents a workspace name.
organizationIdstringNoRepresents the Cake organization identifier across the system.

clockify_workspace_delete

Delete a custom field Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents workspace identifier across the system.
customFieldIdstringYesRepresents custom field identifier across the system.

clockify_workspace_delete_policy

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

clockify_workspace_delete_user

Remove a user from a group Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userGroupIdstringYesRepresents a user group identifier across the system.
userIdstringYesRepresents a user identifier across the system.

clockify_workspace_delete_user_group

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

clockify_workspace_delete_user_role

Remove user’s manager role Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
entityIdstringYesRepresents an entity identifier across the system.
rolestringYesRepresents a valid role.
sourceTypestringNoOptional 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
webhookIdstringYesRepresents a webhook identifier across the system.

clockify_workspace_edit_custom_field

Update custom field on workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
customFieldIdstringYesRepresents a custom field identifier across the system.
allowedValuesstring[]NoRepresents a list of custom field’s allowed values.
descriptionstringNoRepresents a custom field description.
namestringYesRepresents a custom field name.
onlyAdminCanEditbooleanNoFlag to set whether custom field is modifiable only by admin users.
placeholderstringNoRepresents a custom field placeholder value.
requiredbooleanNoFlag to set whether custom field is mandatory or not.
statusstringNoRepresents a custom field status
typestringYesRepresents a custom field type.
workspaceDefaultValueobjectNoRepresents a custom field’s default value in the workspace.

clockify_workspace_edit_project_custom_field_default_value

Update custom field on a project Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
customFieldIdstringYesRepresents a custom field identifier across the system.
defaultValueobjectNoRepresents a custom field’s default value.
statusstringNoRepresents a custom field status.

clockify_workspace_filter_users_of_workspace

Filter workspace users Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
accountStatusesstring[]NoIf 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.
emailstringNoIf provided, you’ll get a filtered list of users that contain the provided string in their email address.
includeRolesbooleanNoIf you pass along includeRoles=true, you’ll get each user’s detailed manager role (including projects and members for whom they’re managers)
membershipsstringNoIf provided, you’ll get all users along with workspaces, groups, or projects they have access to.
namestringNoIf provided, you’ll get a filtered list of users that contain the provided string in their name.
pageintegerNoPage number.
pageSizeintegerNoPage size.
projectIdstringNoIf provided, you’ll get a list of users that have access to the project.
rolesstring[]NoIf provided, you’ll get a filtered list of users that have any of the specified roles. Owners are counted as admins when filtering.
sortColumnstringNoSorting criteria
sortOrderstringNoSorting mode
statusstringNoIf provided, you’ll get a filtered list of users with the corresponding status.
userGroupsstring[]NoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
pagestringNoPage number.
page-sizeintegerNoPage size.
namestringNoIf provided, you’ll get a filtered list of policies that contain the provided string in their name.
statusstringNoIf provided, you’ll get a filtered list of policies with the corresponding status.
sort-columnstringNoThe sort-column value
sort-orderstringNoThe sort-order value

clockify_workspace_generate_new_token

Generate a new token Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
webhookIdstringYesRepresents a webhook identifier across the system.

clockify_workspace_get_addon_webhooks

Get all webhooks for addon on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
addonIdstringYesRepresents an addon identifier across the system.

clockify_workspace_get_custom_fields_of_project

Get custom fields on a project Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
statusstringNoIf provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field status.
entity-typestringNoIf 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:
ParameterTypeRequiredDefaultDescription
include-membershipsbooleanNoIf set to true, memberships will be included.

clockify_workspace_get_logs_for_webhook

Get logs for a webhook Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
webhookIdstringYesRepresents a webhook identifier across the system.
pageintegerNoPage number.
sizeintegerNoPage size.
fromstringNoRepresents date and time in yyyy-MM-ddThh:mm:ssZ format. If provided, results will include logs which occurred after this value.
sortByNewestbooleanNoIf set to true, logs will be sorted with most recent first.
statusstringNoFilters logs by status.
tostringNoRepresents 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
sort-columnstringNoSorting column criteria
sort-orderstringNoSorting mode
pageintegerNoPage number.
page-sizeintegerNoPage size.

clockify_workspace_get_member_profile

Get a member’s profile Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.

clockify_workspace_get_of_user

Get workspace info Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.

clockify_workspace_get_policy

Get a time off policy Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
idstringYesRepresents a policy identifier across the system.

clockify_workspace_get_user_groups

Find all groups on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
project-idstringNoIf provided, you’ll get a filtered list of groups that matches the string provided in their project id.
namestringNoIf provided, you’ll get a filtered list of groups that matches the string provided in their name.
sort-columnstringNoColumn to be used as the sorting criteria.
sort-orderstringNoSorting mode.
pageintegerNoPage number.
page-sizeintegerNoPage size.
includeTeamManagersbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
emailstringNoIf provided, you’ll get a filtered list of users that contain the provided string in their email address.
project-idstringNoIf provided, you’ll get a list of users that have access to the project.
statusstringNoIf provided, you’ll get a filtered list of users with the corresponding status.
account-statusesstringNoIf 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.
namestringNoIf provided, you’ll get a filtered list of users that contain the provided string in their name
sort-columnstringNoSorting column criteria. Default value: EMAIL
sort-orderstringNoSorting mode. Default value: ASCENDING
pageintegerNoPage number.
page-sizeintegerNoPage size.
membershipsstringNoIf provided, you’ll get all users along with workspaces, groups, or projects they have access to. Default value is NONE.
include-rolesstringYesIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
webhookIdstringYesRepresents a webhook identifier across the system.

clockify_workspace_get_webhooks

Get all webhooks on a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
typestringNoRepresents a webhook type.

clockify_workspace_get_workspaces_of_user

Get all my workspaces Parameters:
ParameterTypeRequiredDefaultDescription
rolesstringNoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoIf provided, you’ll get a filtered list of custom fields that contain the provided string in their name.
statusstringNoIf provided, you’ll get a filtered list of custom fields that matches the provided string with the custom field status.
entity-typestringNoIf 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
projectIdstringYesRepresents a project identifier across the system.
customFieldIdstringYesRepresents a custom field identifier across the system.

clockify_workspace_set_cost_rate_for_user

Update a user’s cost rate Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace 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_workspace_set_hourly_rate_for_user

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

clockify_workspace_set_workspace_cost_rate

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

clockify_workspace_set_workspace_hourly_rate

Update workspace billable rate Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
amountintegerYesRepresents an amount as integer.
currencystringYesRepresents a currency.
sincestringNoRepresents 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:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
imageUrlstringNoRepresents an image url. A field that can only be updated for limited users.
namestringNoThis 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.
removeProfileImagebooleanNoIndicates whether to remove profile image or not. A field that can only be updated for limited users.
userCustomFieldsobject[]NoRepresents a list of upsert user custom field objects.
weekStartstringNoRepresents a day of the week.
workCapacitystringNoRepresents work capacity as a time duration in the ISO-8601 format. For example, for a 7hr work day, input should be PT7H.
workingDaysstringNoRepresents a list of days of the week.

clockify_workspace_update_policy

Update a policy Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
idstringYesRepresents a policy identifier across the system.
allowHalfDaybooleanYesIndicates whether policy allows half day.
allowNegativeBalancebooleanYesIndicates whether policy allows negative balance.
approveobjectYesRepresents approval settings.
archivedbooleanYesIndicates whether policy is archived.
automaticAccrualobjectNoProvide automatic accrual settings.
automaticTimeEntryCreationobjectNoProvides automatic time entry creation settings.
colorstringNoProvide 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.
everyoneIncludingNewbooleanYesIndicates whether the policy is shown to new users.
hasExpirationbooleanYesIndicates whether the policy has expiration.
iconstringNoProvide icon.
namestringYesProvide the name you would like to use for updating the policy.
negativeBalanceobjectNoProvide the negative balance data you would like to use for updating the policy.
userGroupsobjectYesProvide list with user group ids and corresponding status.
usersobjectYesProvide list with user ids and corresponding status.

clockify_workspace_update_policy_status

Change a policy status Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
idstringYesRepresents a policy identifier across the system.
statusstringYesProvide the status you would like to use for changing the policy.

clockify_workspace_update_user_group

Update a group Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRepresents a user group identifier across the system.
workspaceIdstringYesRepresents a workspace identifier across the system.
namestringNoRepresents a user group name.

clockify_workspace_update_user_status

Update a user’s status Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
statusstringYesRepresents membership status.

clockify_workspace_update_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
webhookIdstringYesRepresents a webhook identifier across the system.
namestringNoRepresents a webhook name.
triggerSourcestring[]YesRepresents a list of trigger sources.
triggerSourceTypestringYesRepresents a webhook event trigger source type.
urlstringYesRepresents a workspace identifier across the system.
webhookEventstringYesRepresents a webhook event type.

clockify_workspace_upload_image

Add a photo Parameters:
ParameterTypeRequiredDefaultDescription
filestringYesImage to be uploaded

clockify_workspace_upsert_user_custom_field_value

Update a user’s custom field Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesRepresents a workspace identifier across the system.
userIdstringYesRepresents a user identifier across the system.
customFieldIdstringYesRepresents custom field identifier across the system.
valueobjectNoRepresents custom field value.