Document toolboxDocument toolbox

Worklog query


The worklog query can be accessed from the link below: JIRA-URL/rest/jttp-rest/REST-API-VERSION/worklog-query/worklogQuery

REST-API-VERSION after version 4.2.0 is "4" or "latest"

The query returns the worklogs that belong to the specified interval. The query considers the start date value of the worklog.


The GET parameter of the worklogs query is a JSON: "filterConditionJson" and an optional "customFieldsFilter".

The available keys of the parameter filterConditionJson:

parametervalueoptionaldescription
groupUsersstring listtrue

The JIRA group or list of user names whose worklogs are to be listed. The default value is all users.

  • "groupUsers":["groups:jira-administrators"]
  • "groupUsers":["users:testUser"]

The "groupUsers" parameter requires userKey value

issueAffectedVersionsstring listtrueThe affected version of a JIRA issue.
issueAssigneesstring listtrueThe assignee of a JIRA issue, specifying with the assignee's user key.
issueComponentsstring listtrueThe related component name of a JIRA issue.
issueFixedVersionsstring listtrueThe fix version of a JIRA issue.
issueKeysstring listtrueThe key parameter of a JIRA issue. Unless it is defined, all issues are queried.
issueStatusNamesstring listtrueThe status name of a JIRA issue.
issueTypeNamesstring listtrueThe type name of a JIRA issue.
limitlongtrueThe number of results returned.
offsetlongtrueThe first entry to return from the results.
projectKeysstring listtrueThe key parameter of a JIRA project. Unless it is defined, all projects are queried.
worklogEndDate"YYYY-MM-DD"falseThe end date until which the worklogs can be viewed. The query is run until the end of the given day (23:59:59).
worklogStartDate"YYYY-MM-DD"falseThe start date from which the worklogs can be viewed. The query is run from the beginning of the given day (00:00:00)


Components are sub-sections of a project

The customFieldsFilter is a JSON array containing the custom field ids of the custom fields you would like to be returned in the response.

query parametervalueoptionaldescription
customFieldsFilternumber listtrueThe id-s of the customfields you would like to be returned in the response.