Starting a project
The Start Project & Task endpoint allows you to start tracking time for a given project and optionally a task.
When you send a GET request to this endpoint, the server will attempt to start tracking time for the provided project. If a task name is also provided, the server will attempt to associate the time tracking with the specified task.
The server will respond with a JSON object containing a boolean value indicating whether the tracking was started successfully, along with a timestamp of the request.
https://desktime.com/api/v2/json/start-project?project={project}&task={task}- project: project name (required)
- task: task name (optional)
Authenticate by sending your API key in the X-API-Key request header.
X-API-Key: {apiKey}- X-API-Key: user api key (required)
Response example:
{
"started": true,
"__request_time": "1678957078"
}Stopping a project
The Stop Project & Task endpoint allows you to stop tracking time for a given project and optionally a task.
When you send a GET request to this endpoint, the server will attempt to stop tracking time for the provided project and task, if the task name is provided.
The server will respond with a JSON object containing a boolean value indicating whether the tracking was started successfully, along with a timestamp of the request.
https://desktime.com/api/v2/json/stop-project?project={project}&task={task}- project: project name (required)
- task: task name (optional)
Authenticate by sending your API key in the X-API-Key request header.
X-API-Key: {apiKey}- X-API-Key: user api key (required)
Response example:
{
"stopped": true,
"__request_time": "1678957088"
}