The GitScrum API provides endpoints for managing time tracking resources, such as creating and updating time entries, getting time report data, setting pay rates for time entry records, and getting time sheet summaries.
Using the API, users can gain insights into how long tasks have taken to complete, identify potential bottlenecks in their workflow, and analyze the effectiveness of their processes.
| POST |
/timer/start |
| POST |
/timer/end |
| GET |
/time-trackings/no-task |
| POST |
/time-trackings |
| DELETE |
/time-trackings/:id |
Attributes
comment STRING
The comment attribute is a feature of task time tracking where a user can add additional comments when they stop a timer. This comment provides more information about the task that was completed and helps to better document the time spent on it.
time.id NUMBER
The id attribute is a unique numerical identifier that is used to track a particular object or resource over time. It typically serves as a way to differentiate between different objects or resources and provides an efficient way to reference them.
time.start STRING
The start is an attribute that refers to the beginning of a time period being tracked or monitored. It typically indicates the point in time at which data collection or analysis begins.
time.end STRING
The end is an attribute of a time tracking event which indicates when the tracking of time for the event has stopped. It is typically used to measure the duration of some activity or task, such as a work shift.
More Attributes
{
"comment": string,
"time": {
"id": number,
"start": object,
"end": object,
"total": string,
"UTC": object
},
"user": object,
"billed": boolean
}Add a Time Tracker Manually with the GitScrum API's Start Time Tracking endpoint by making a POST request.
Parameters
task_uuid STRING REQUIRED
The "task_uuid" is a universally unique identifier (UUID) that identifies a particular task.
comment STRING
The comment attribute is a feature of task time tracking where a user can add additional comments when they stop a timer. This comment provides more information about the task that was completed and helps to better document the time spent on it.
start STRING
The start attribute is typically represented in the format of yy-mm-dd hh:mm:ss, and it refers to the beginning of a time period being tracked or monitored. It indicates the point in time at which data collection or analysis begins.
end STRING
The end is an attribute of a time tracking event which indicates when the tracking of time for the event has stopped, usually in the format of yy-mm-dd hh:mm:ss. It is typically used to measure the duration of some activity or task, such as a work shift.
POST /time-trackings
{
"comment": "Work Description",
"time": {
"id": 917,
"start": {
"date_for_humans": "1 day ago",
"timezone": "2023-05-10 11:00:00",
"timestamp": 1683716400
},
"end": {
"date_for_humans": "21 hours ago",
"timezone": "2023-05-10 15:00:00",
"timestamp": 1683730800
},
"total": "4h ",
"UTC": {
"offset": "(UTC+00:00) Greenwich Mean Time : Dublin",
"location": "Etc/Greenwich"
}
},
"task": {
"uuid": "39579ac6-c93c-4c13-8c8e-da0e7f5ebc8f",
"code": "#PROJC-8",
"effort": {
"title": "Large",
"effort": "1.00"
},
"type": {
"title": "Marketing",
"color": "9900ff"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 5203,
"slug": "issue-todo",
"state": 0,
"title": "Todo",
"color": "b3dc6c"
},
"parent_id": null,
"image": null,
"labels": [],
"slug": "teste",
"state": null,
"title": "teste",
"description": "teste
",
"analyse": {
"risk": null
},
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
},
"users": [],
"features": [],
"completed_user": null,
"completed_date": [],
"start_date": {
"date_for_humans": "2 weeks from now",
"timezone": "2023-05-31 1:30:00",
"timestamp": 1685496600
},
"due_date": {
"date_for_humans": "1 month from now",
"timezone": "2023-06-29 2:00:00",
"timestamp": 1688004000
},
"created_at": {
"date_for_humans": "1 day ago",
"timezone": "2023-05-09 19:21:28",
"timestamp": 1683660088
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": false,
"is_archived": false
},
"time_tracker": null,
"time_tracker_user": null,
"stats": {
"votes": 0,
"fields": 0,
"time_trackers": 0,
"comments": 0,
"checklists": 0,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#882A2A",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9575b6c36682f58fd61e981ae843aac6e6e34263.png",
"owner": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
}
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": false,
"limit": 0
},
"owner": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
}
},
"board": {
"label": "Main Board",
"uuid": "main-board"
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": null,
"title": null
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
},
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
},
"billed": false
}
The GitScrum API's Start Time Tracker endpoint enables users to initiate time tracking for tasks by making a POST request.
Parameters
task_uuid STRING REQUIRED
The task_uuid is a universally unique identifier (UUID) that identifies a particular task.
POST /timer/start
trueThe GitScrum API's Stop Time Tracker endpoint enables users to end time tracking for tasks by making a POST request.
Parameters
task_uuid STRING REQUIRED
The task_uuid is a universally unique identifier (UUID) that identifies a particular task.
comment STRING REQUIRED
The comment attribute is a feature of task time tracking where a user can add additional comments when they stop a timer. This comment provides more information about the task that was completed and helps to better document the time spent on it.
Returns
Returns a task object if a valid identifier is supplied.
POST /timer/end
trueGet a sorted list of your Task Time Trackers, with the most recently created Time Trackers appearing first, using a GET request.
Parameters
task_uuid STRING REQUIRED
The Task UUID is a universally unique identifier (UUID) that identifies a particular task.
page NUMBER OPTIONAL
The page parameter can be used in subsequent calls to access additional pages of results after the initial page. It allows for pagination, allowing the user to navigate through multiple pages of search results.
GET /time-trackings/no-task
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}To delete a Task Time Tracker, use the DELETE method.
Parameters
id STRING REQUIRED
The id attribute is an identifier used in the Time Tracker system to uniquely identify and differentiate each tracked item.
Returns
Returns a deleted object on success.
DELETE /time-trackings/:id
{ }