Skip to main content
Skip table of contents

Jira Worklog API Migration

This page outlines the Jira API equivalents to the Time Tracker APIs that will be deprecated on November 21, 2025.

Retrieving Worklogs

Today, the Time Tracker public API returns worklogs by calling the endpoint https://timesheet-reports-gadgets.tempo.io/api/1/worklog, which returns a range of worklogs for a specific filter.

It's possible to do the same using these Jira APIs:

Jira Endpoint
GET /rest/api/3/search/jql

Parameters

  • jql: worklogDate >= "2023-01-01" AND worklogDate <= "2023-12-31"

  • fields: list of fields to return (e.g., worklog,summary)

  • expand: to include extra data like changelog

The above parameters were sourced from Jira REST API docs.

Notes
The fields.worklog object in /search responses contains 20 worklogs per issue at most.

To retrieve all worklogs for an issue, use GET /rest/api/3/issue/{issueIdOrKey}/worklog and paginate using startAt and maxResults. See Worklog API for more information.

Creating a Worklog

Logging time via the Time Tracker public API can be done by calling the endpoint https://timesheet-reports-gadgets.tempo.io/api/1/logWork. It is also possible to do this using Jira APIs.

Jira Endpoint
POST /rest/api/3/issue/{issueKey}/worklog

Request Body

CODE
{
  "timeSpentSeconds": 12000,
  "started": "2023-12-20T08:00:00.000+0000",
  "comment": {
    "type": "doc",
    "version": 1,
    "content": [
      {
        "type": "paragraph",
        "content": [
          { "type": "text", "text": "Work description" }
        ]
      }
    ]
  }
}

Optional Query Parameters

  • notifyUsers (boolean)

  • adjustEstimate, newEstimate, reduceBy (strings)

  • overrideEditableFlag (boolean)

  • expand (string)

Handling Authentication on Jira Cloud

Two authentication methods are supported for Jira Cloud:

  • Basic Auth with API Token
    Authorization: Basic <base64(email:apiToken)>

  • OAuth 2.0 (3LO)
    Authorization: Bearer <your-access-token>

Side-by-Side Comparison

Time Tracker API

Jira REST API v3

Authentication

Authorization: Apkkey <KEY>

Basic + API Token or OAuth 2.0

Date parameters

star/end (YYY-MM-DD)

JQL worklogDate in /search or worklog endpont

Extra parameters

user, groups, filterOrProjectId

fields, expand, startAt, maxResults

Worklog limit/issue

Not limited

Max 20 in /search; use issue worklog

Migration Checklist

  1. Replace all calls to the Tempo API with Jira REST API endpoints (/rest/api/3/...).

  2. Switch from/to for the JQL worklogDate >= "#START" AND worklogDate <= "#END"

  3. Update authentication to use either Basic + API token or OAuth 2.0.

  4. Note the 20-worklog limit per issue in /search responses.

  5. Handle pagination when retrieving worklogs from /search or /issue/{issueIdOrKey}/worklog.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.