In this article, you will find the list of Time Tracking and Time Tracking Suggestions API Requests.
For the general overview of the Time Tracking API, how to create an API token, and important details, please refer to the 'Time Tracking API' article.
TIME TRACKING API REQUESTS
Returns Time Tracking Entries List
You can retrieve a list of time entries for the resource whose Personal Access Token is being used. The entries can be fetched for a specified period, such as a day, week, or month.
To perform this operation:
- The tenant must be defined.
- Both Start Date and End Date need to be provided.
The specified date range must not exceed 31 days.
Get request:
https://host/@tenant-name/v1.0/TimeTracking?Start=2024-11-01&End=2024-11-30
Returns Time Tracking Entries List for the Specified Resource
You can retrieve a list of time entries for a specific resource for a defined period, such as a day, week, or month.
To perform this operation:
- The tenant must be specified.
- Both Start Date and End Date need to be provided.
- The Resource ID of the specified resource must be included.
The specified date range must not exceed 31 days, and the user making the API request must have Manage Resource permission.
Get request:
https://host/@tenant-name/v1.0/TimeTracking/resource/{id}?Start=2024-11-01&End=2024-11-30
Returns a list of Administrative Categories
You can get the list of Administrative Categories. To perform this operation:
- The tenant must be specified.
Get Request:
https://host/@tenant-name/v1.0/TimeTracking/administrativecategories
Creates a Time Tracking Entry
You can create a time entry for the resource whose Personal Access Token is being used.
To create a time entry, the following must be specified:
- Tenant
- Project ID
- Task ID
- Custom Time Name or Administrative Category, depending on the type of time entry being created: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTracking
Create Time Entry on project task:
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c1e1"
},
"Task": {
"id": "9a055ea3-53be-4813-9783-8505c3204d11"
},
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Create Custom Time Entry:
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c2e2"
},
"CustomTimeEntryName": "Custom Project Non-Task Activity name",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}For custom time and project task you can define Billable and Cost Type values.
- "IsBillable": "true",
- "CostType": "CAPEX"
Also, you can define any Time Tracking custom field.
Create Time Entry on Admin Category:
{
"attributes": {
"AdministrativeCategory": "Administrative Category Id",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Creates a List of Time Tracking Entries
This endpoint allows you to create multiple time tracking entries for the resource whose Personal Access Token is being used.
To create a list of time entries, the following details must be provided:
- Tenant
- Project ID
- Task ID
- Custom Time Name or Administrative Category, depending on the type of time entry being created: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTracking/bulk/create
[
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]Creates a Time Tracking Entry for the Specified Resource
You can create a time entry for a specified resource.
To create a time entry, the following information must be provided:
- Tenant
- Resource ID
- Project ID
- Task ID
- Custom Time Name or Administrative Category, based on the type of time entry being created: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTracking/resource/{id}
Create Time Entry on project task
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c1e1"
},
"Task": {
"id": "9a055ea3-53be-4813-9783-8505c3204d11"
},
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Create Custom Time Entry
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c2e2"
},
"CustomTimeEntryName": "Custom Project Non-Task Activity name",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}You can define Billable and Cost Type values for custom time and project tasks.
- "IsBillable": "true",
- "CostType": "CAPEX"
Also, you can define any Time Tracking custom field.
Create Time Entry on Admin Category
{
"attributes": {
"AdministrativeCategory": "Administrative Category Id",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Creates a List of Time Tracking Entries for the Specified Resource
You can create multiple time tracking entries for a specified resource.
To create a list of time entries, the following details must be provided:
- Tenant
- Resource ID
- Project ID
- Task ID
- Custom Time Name or Administrative Category, depending on the type of time entry being created: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTracking/resource/{id}/bulk/create
[
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]Updates a Time Tracking Entry
You can update an existing time tracking entry.
To perform an update, the following information must be specified:
- Tenant
- Time Entry ID
- The fields you wish to update.
The following fields cannot be modified:
- Project
- Task
- Date
- Administrative Category
Patch request:
https://host/@tenant-name/v1.0/TimeTracking/{id}
{
"attributes": {
"Duration": 4,
"Description": "Some work description if needed",
}
}Updates a List of Time Tracking Entries
You can update multiple existing time tracking entries in bulk.
To perform a bulk update, the following information must be specified:
- Tenant
- Time Entry IDs
- The fields you wish to update.
The following fields cannot be modified:
- Project
- Task
- Date
- Administrative Category
Post request:
https://host/@tenant-name/v1.0/TimeTracking/bulk/update
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]Deletes a Time Tracking Entry
You can delete an existing time tracking entry.
To delete a time entry, the following information must be provided:
- Tenant
- Entry ID
Delete request:
https://host/@tenant-name/v1.0/TimeTracking/v1.0/TimeTracking/{id}
Deletes a List of Time Tracking Entries
You can delete multiple existing time tracking entries in bulk.
To perform a bulk deletion, the following information must be provided:
- Tenant
- Entry IDs
Post request:
https://host/@tenant-name/v1.0/TimeTracking/bulk/delete
{
"ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"3fa85f64-5717-4562-b3fc-2c963f66afa7"
]
}TIME TRACKING SUGGESTIONS API REQUESTS
Returns Time Tracking Entries list
You can retrieve a list of time entries for the resource Personal Access Token is being used for a specified period, such as a day, week, or month.
To perform this operation, the following details must be specified:
- Tenant.
- Start Date and End Date.
The date range must not exceed 31 days.
Get request:
https://host/@tenant-name/v1.0/TimeTracking?Start=2024-12-01&End=2024-12-31
Returns Time Tracking Entries List for the Specified Resource
You can retrieve a list of time entries for a specified resource for a given period, such as a day, week, or month.
To perform this operation, the following details must be specified:
- Tenant.
- Start Date and End Date.
- Resource ID.
The date range must not exceed 31 days. The user making the API request must have Manage Resource permission.
Get request:
https://host/@tenant-name/v1.0/TimeTracking/resource/{id}?Start=2024-12-01&End=2024-12-31
Creates a Time Tracking Entry
You can create an external time tracking suggestion for the resource associated with the Personal Access Token being used.
To create an external suggestion, the following details must be specified:
- Tenant
- Project ID
- Task ID
- Custom Time Name or Administrative Category: Specify one based on the type of time entry: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions
Create Time Entry on project task
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c1e1"
},
"Task": {
"id": "9a055ea3-53be-4813-9783-8505c3204d11"
},
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Create Custom Time Entry
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c2e2"
},
"CustomTimeEntryName": "Custom Project Non-Task Activity name",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}For custom time and project task you can define Billable and Cost Type values.
- "IsBillable": "true",
- "CostType": "CAPEX"
Also, you can define any Time Tracker custom fields.
Create Time Entry on Admin Category
{
"attributes": {
"AdministrativeCategory": "Administrative Category Id",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Creates a List of Time Tracking Entries
This endpoint allows you to create multiple external time tracking suggestions for the resource associated with the Personal Access Token being used.
To create a list of external suggestions, the following details must be specified:
- Tenant
- Project ID
- Task ID
- Custom Time Name or Administrative Category: Specify one based on the type of time entry: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions/bulk/create[
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]Creates a Time Tracking Entry for the Specified Resource
You can create an external time tracking suggestion for a specified resource.
To create an external suggestion, the following information must be provided:
- Tenant:
- Resource ID
- Project ID
- Task ID
- Custom Time Name or Administrative Category: Specify one based on the type of time entry: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions/resource/{id}
Create Time Entry on project task
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c1e1"
},
"Task": {
"id": "9a055ea3-53be-4813-9783-8505c3204d11"
},
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Create Custom Time Entry
{
"attributes": {
"Project": {
"id": "0f371928-aceb-4a0b-a0df-0bf91876c2e2"
},
"CustomTimeEntryName": "Custom Project Non-Task Activity name",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}For custom time and project task you can define Billable and Cost Type values.
- "IsBillable": "true",
- "CostType": "CAPEX"
Also, you can define any Time Tracker custom fields.
Create Time Entry on Admin Category
{
"attributes": {
"AdministrativeCategory": "Administrative Category Id",
"Duration": 4,
"Date": "2024-11-25T00:00:00Z",
"Description": "Some work description if needed",
}
}Creates a List of Time Tracking Entries for the Specified Resource
You can create multiple external time tracking suggestions for a specified resource.
To create a list of external suggestions, the following details must be provided:
- Tenant
- Resource ID
- Project ID
- Task ID
- Custom Time Name or Administrative Category: Specify one based on the type of time entry: Project-level time entries, Custom time entries, or Administrative time entries.
Post request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions/resource/{id}/bulk/create
[
{
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}Deletes a Time Tracking Entry
You can delete an existing external time tracking suggestion.
To delete a time tracking suggestion, the following details must be provided:
- Tenant
- Entry ID
Delete request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions/{id}
Deletes a List of Time Tracking Entries
You can delete multiple external time tracking suggestions in bulk.
To delete a list of time tracking suggestions, the following details must be provided:
- Tenant
- Entry IDs
Post request:
https://host/@tenant-name/v1.0/TimeTrackingSuggestions/bulk/delete
{
"ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"3fa85f64-5717-4562-b3fc-2c963f66afa7"
]
}