/clockify-time-tracking | Type: Application | PCID required: Yes
Tools
clockify_time_tracking_change_time_off_request_status
Change a time off request status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
requestId | string | Yes | — | Represents a time off request identifier across the system. |
note | string | No | — | Provide the note you would like to use for changing the time off request. |
status | string | No | — | Provide the status you would like to use for changing the time off request. |
clockify_time_tracking_copy_assignment
Copy a scheduled assignment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assignmentId | string | Yes | — | Represents an assignment identifier across the system. |
seriesUpdateOption | string | No | — | Represents a series update option. |
userId | string | Yes | — | Represents a user identifier across the system. |
clockify_time_tracking_create_approval_for_other
Submit an approval request for 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. |
period | string | No | — | Specifies the approval period. It has to match the workspace approval period setting. |
periodStart | string | Yes | — | Specifies an approval period start date in yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_create_apprroval_request
Submit approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
period | string | No | — | Specifies the approval period. It has to match the workspace approval period setting. |
periodStart | string | Yes | — | Specifies an approval period start date in yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_create_for_others
Add a new time entry for another user on workspace 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. |
from-entry | string | No | — | Represents a time entry identifier across the system. |
billable | boolean | No | — | Indicates whether a time entry is billable or not. |
customAttributes | object[] | No | — | Represents a list of create custom field request objects. |
customFields | object[] | No | — | Represents a list of value objects for user’s custom fields. |
description | string | No | — | Represents time entry description. |
end | string | No | — | Represents an end date in yyyy-MM-ddThh:mm:ssZ format. |
projectId | string | No | — | Represents a project identifier across the system. |
start | string | No | — | Represents a start date in yyyy-MM-ddThh:mm:ssZ format. |
tagIds | string[] | No | — | Represents a list of tag ids. |
taskId | string | No | — | Represents a task identifier across the system. |
type | string | No | — | Valid time entry type. |
clockify_time_tracking_create_holiday
Create a holiday Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
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. |
datePeriod | object | Yes | — | Provide startDate and endDate for the holiday. |
everyoneIncludingNew | boolean | No | — | Indicates whether the holiday is shown to new users. |
name | string | Yes | — | Provide the name of the holiday. |
occursAnnually | boolean | No | — | Indicates whether the holiday occurs annually. |
userGroups | object | No | — | Provide list with user group ids and corresponding status. |
users | object | No | — | Provide list with user ids and corresponding status. |
clockify_time_tracking_create_recurring
Create a recurring assignment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
billable | boolean | No | — | Indicates whether assignment is billable or not. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
hoursPerDay | number | Yes | — | Represents assignment total hours per day. |
includeNonWorkingDays | boolean | No | — | Indicates whether to include non-working days or not. |
note | string | No | — | Represents an assignment note. |
projectId | string | Yes | — | Represents a project identifier across the system. |
recurringAssignment | object | No | — | Recurring Assignment |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
startTime | string | No | — | Represents a start time in the hh:mm:ss format. |
taskId | string | No | — | Represents a task identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
clockify_time_tracking_create_time_entry
Add a new time entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
billable | boolean | No | — | Indicates whether a time entry is billable or not. |
customAttributes | object[] | No | — | Represents a list of create custom field request objects. |
customFields | object[] | No | — | Represents a list of value objects for user’s custom fields. |
description | string | No | — | Represents time entry description. |
end | string | No | — | Represents an end date in yyyy-MM-ddThh:mm:ssZ format. |
projectId | string | No | — | Represents a project identifier across the system. |
start | string | No | — | Represents a start date in yyyy-MM-ddThh:mm:ssZ format. |
tagIds | string[] | No | — | Represents a list of tag ids. |
taskId | string | No | — | Represents a task identifier across the system. |
type | string | No | — | Valid time entry type. |
clockify_time_tracking_create_time_off_request
Create a time off request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
note | string | No | — | Provide the note you would like to use for creating the time off request. |
timeOffPeriod | object | Yes | — | Provide the period you would like to use for creating the time off request. If timeZone isn’t set, should be aligned with time zone for user in settings. Can be shifted from user time zone with explicit setting of timeZone. |
clockify_time_tracking_create_time_off_request_for_other
Create a time off request for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
userId | string | Yes | — | Represents a user identifier across the system. |
note | string | No | — | Provide the note you would like to use for creating the time off request. |
timeOffPeriod | object | Yes | — | Provide the period you would like to use for creating the time off request. If timeZone isn’t set, should be aligned with time zone for user in settings. Can be shifted from user time zone with explicit setting of timeZone. |
clockify_time_tracking_delete_entry
Delete a time entry from a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a time entry identifier across the system. |
clockify_time_tracking_delete_holiday
Delete a holiday Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
holidayId | string | Yes | — | Represents a holiday identifier across the system. |
clockify_time_tracking_delete_many
Delete all time entries for a user on a workspace 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. |
time-entry-ids | string[] | Yes | — | Represents a list of time entry ids to delete. |
clockify_time_tracking_delete_off_request
Delete a time off request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
requestId | string | Yes | — | Represents a time off request identifier across the system. |
clockify_time_tracking_delete_rrecurring_assignment
Delete a recurring assignment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assignmentId | string | Yes | — | Represents an assignment identifier across the system. |
seriesUpdateOption | string | No | — | Represents a series option. |
clockify_time_tracking_duplicate_time_entry
Duplicate a time entry 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. |
id | string | Yes | — | Represents a time entry identifier across the system. |
clockify_time_tracking_edit_recurring
Update a recurring assignment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assignmentId | string | Yes | — | Represents an assignment identifier across the system. |
billable | boolean | No | — | Indicates whether assignment is billable or not. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
hoursPerDay | number | No | — | Represents assignment total hours per day. |
includeNonWorkingDays | boolean | No | — | Indicates whether to include non-working days or not. |
note | string | No | — | Represents an assignment note. |
seriesUpdateOption | string | No | — | Valid series option |
start | string | Yes | — | Represents start date in yyyy-MM-ddThh:mm:ssZ format. |
startTime | string | No | — | Represents a start time in the hh:mm:ss format. |
taskId | string | No | — | Represents task identifier across the system. |
clockify_time_tracking_edit_recurring_period
Change the recurring period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assignmentId | string | Yes | — | Represents an assignment identifier across the system. |
repeat | boolean | No | — | Indicates whether assignment is recurring or not. |
weeks | integer | Yes | — | Indicates number of weeks for assignment. |
clockify_time_tracking_get_all_assignments
Get all assignments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
name | string | No | — | If provided, assignments will be filtered by name |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
end | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
sort-column | string | No | — | Represents the column as the sorting criteria. |
sort-order | string | No | — | Represents the sorting mode. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
clockify_time_tracking_get_approval_requests
Get approval requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
status | string | No | — | Filters results based on the provided approval state. |
sort-column | string | No | — | Represents the column name to be used as sorting criteria. |
sort-order | string | No | — | Represents the sorting order. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
clockify_time_tracking_get_balances_for_policy
Get balances for a policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
page | integer | No | — | Page number for pagination |
page-size | integer | No | — | Number of results per page |
sort | string | No | — | If provided, you’ll get result sorted by sort column. |
sort-order | string | No | — | Sort results in ascending or descending order. |
clockify_time_tracking_get_balances_for_user
Get balance for 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. |
page | string | No | — | Page number. |
page-size | string | No | — | Page size. |
sort | string | No | — | Sort result based on given criteria |
sort-order | string | No | — | Sort result by providing sort order. |
clockify_time_tracking_get_entries
Get time entries for a user on a workspace 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. |
description | string | No | — | Represents a term for searching time entries by description. |
start | string | No | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
end | string | No | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
project | string | No | — | If provided, you’ll get a filtered list of time entries that matches the provided string in their project id. |
task | string | No | — | If provided, you’ll get a filtered list of time entries that matches the provided string in their task id. |
tags | string[] | No | — | If provided, you’ll get a filtered list of time entries that matches the provided string(s) in their tag id(s). |
project-required | boolean | No | — | Flag to set whether to only get time entries which have a project. |
task-required | boolean | No | — | Flag to set whether to only get time entries which have tasks. |
hydrated | boolean | No | — | Flag to set whether to include additional information on time entries or not. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
in-progress | string | No | — | Flag to set whether to filter only in progress time entries. |
get-week-before | string | No | — | Valid yyyy-MM-ddThh:mm:ssZ format date. If provided, filters results within the week before the datetime provided and only those entries with assigned project or task. |
clockify_time_tracking_get_entry
Get a specific time entry on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a time entry identifier across the system. |
hydrated | boolean | No | — | Flag to set whether to include additional information of a time entry or not. |
clockify_time_tracking_get_filtered_project_totals
Get all scheduled assignments per project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
page | integer | No | — | Page number. |
pageSize | integer | No | — | Page size. |
search | string | No | — | Represents a term for searching projects and clients by name. |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
statusFilter | string | No | — | Filters assignments by status. |
clockify_time_tracking_get_holidays
Get holidays on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assigned-to | string | No | — | If provided, you’ll get a filtered list of holidays assigned to user. |
clockify_time_tracking_get_holidays_in_period
Get holidays in a specific period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
assigned-to | string | Yes | — | Filter list of holidays assigned to user. |
start | string | Yes | — | Filter list of holidays starting from start date. Expected date format yyyy-MM-ddThh:mm:ssZ |
end | string | Yes | — | Filter list of holidays ending by end date. Expected date format yyyy-MM-ddThh:mm:ssZ |
clockify_time_tracking_get_in_progress_time_entries
Get all in progress time entries on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace Id |
page | integer | No | — | Page number for pagination |
page-size | integer | No | — | Number of results per page |
clockify_time_tracking_get_off_request
Get all time off requests on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
end | string | No | — | Return time off requests created before the specified time in requester’s time zone. Provide end in format YYYY-MM-DDTHH:MM:SS.ssssssZ |
page | integer | No | — | Page number. |
pageSize | integer | No | — | Page size. |
start | string | No | — | Return time off requests created after the specified time in requester’s time zone. Provide start in format YYYY-MM-DDTHH:MM:SS.ssssssZ |
statuses | string[] | No | — | Filters time off requests by status. |
userGroups | string[] | No | — | Provide the user group ids of time off requests. |
users | string[] | No | — | Provide the user ids of time off requests. If empty, will return time off requests of all users (with a maximum of 5000 users). |
clockify_time_tracking_get_project_totals_for_single_project
Get all scheduled assignments on 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. |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_get_user_totals
Get total of users’ capacity on workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
page | integer | No | — | Page number. |
pageSize | integer | No | — | Page size. |
search | string | No | — | Represents the keyword for searching users by name or email. |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
statusFilter | string | No | — | Filters assignments by status. |
userFilter | object | No | — | Represents a user filter request object. |
userGroupFilter | object | No | — | Represents a user group filter request object. |
clockify_time_tracking_get_user_totals_for_single_user
Get total capacity of 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. |
page | integer | No | — | Page number. |
page-size | integer | No | — | Page size. |
start | string | Yes | — | Represents a start date in the yyyy-MM-ddThh:mm:ssZ format. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_publish_assignments
Publish assignments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
end | string | Yes | — | Represents end date in yyyy-MM-ddThh:mm:ssZ format. |
notifyUsers | boolean | No | — | Indicates whether to notify users when assignment is published. |
search | string | No | — | Represents a search string. |
start | string | Yes | — | Represents start date in yyyy-MM-ddThh:mm:ssZ format. |
userFilter | object | No | — | Represents a user filter request object. |
userGroupFilter | object | No | — | Represents a user group filter request object. |
viewType | string | No | — | Represents view type. |
clockify_time_tracking_replace_many
Bulk edit time entries 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. |
hydrated | boolean | No | — | If set to true, results will contain additional information about the time entry. |
body | object[] | Yes | — | Request body |
clockify_time_tracking_resubmit_approval_request
Submit non pending/approved entries/expenses for approval to an existing approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
period | string | No | — | Specifies the approval period. It has to match the workspace approval period setting. |
periodStart | string | Yes | — | Specifies an approval period start date in yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_resubmit_approval_request_for_other
Re-submit rejected/withdrawn entries/expenses for an approval of 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. |
period | string | No | — | Specifies the approval period. It has to match the workspace approval period setting. |
periodStart | string | Yes | — | Specifies an approval period start date in yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_stop_running_time_entry
Stop a currently running timer on a workspace for 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. |
end | string | Yes | — | Represents an end date in the yyyy-MM-ddThh:mm:ssZ format. |
clockify_time_tracking_update_approval_status
Update an approval request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
approvalRequestId | string | Yes | — | Represents an approval request identifier across the system. |
note | string | No | — | Additional notes for the approval request. |
state | string | Yes | — | Specifies the approval state to set. |
clockify_time_tracking_update_balance
Update a balance Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
policyId | string | Yes | — | Represents a policy identifier across the system. |
note | string | No | — | Represents a new balance note value. |
userIds | string[] | Yes | — | Represents the list of users’ identifiers whose balance is to be updated. |
value | number | Yes | — | Represents a new balance value. |
clockify_time_tracking_update_holiday
Update a holiday Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
holidayId | string | Yes | — | Represents a holiday identifier across the system. |
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. |
datePeriod | object | Yes | — | Provide startDate and endDate for the holiday. |
everyoneIncludingNew | boolean | No | — | Indicates whether the holiday is shown to new users. |
name | string | Yes | — | Provide the name you would like to use for updating the holiday. |
occursAnnually | boolean | Yes | — | Indicates whether the holiday occurs annually. |
userGroups | object | No | — | Provide list with user group ids and corresponding status. |
users | object | No | — | Provide list with users ids and corresponding status. |
clockify_time_tracking_update_invoiced_status
Mark time entries as invoiced Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
invoiced | boolean | Yes | — | Indicates whether time entry is invoiced or not. |
timeEntryIds | object[] | Yes | — | Represents a list of invoiced time entry ids |
clockify_time_tracking_update_time_entry
Update time entry on a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Represents a workspace identifier across the system. |
id | string | Yes | — | Represents a time entry identifier across the system. |
billable | boolean | No | — | Indicates whether a time entry is billable or not. |
customFields | object[] | No | — | Represents a list of value objects for user’s custom fields. |
description | string | No | — | Represents time entry description. |
end | string | No | — | Represents an end date in yyyy-MM-ddThh:mm:ssZ format. |
projectId | string | No | — | Represents a project identifier across the system. |
start | string | Yes | — | Represents a start date in yyyy-MM-ddThh:mm:ssZ format. |
tagIds | string[] | No | — | Represents a list of tag ids. |
taskId | string | No | — | Represents a task identifier across the system. |
type | string | No | — | The type value |

