Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Issue worklogs

Get worklogs

Returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

  • the worklog is set as Viewable by All Users.
  • the user is a member of a project role or group with permission to view the worklog.
post/rest/api/2/worklog/list

Query parameters

expandstring

Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

Request body

idsinteger[] required

A list of worklog IDs.

Response

Returned if the request is successful.

commentstring

A comment about the worklog. Optional when creating or updating a worklog.

createdstring date-time

The datetime on which the worklog was created.

idstring

The ID of the worklog record.

issueIdstring

The ID of the issue this worklog is for.

selfstring uri

The URL of the worklog item.

startedstring date-time

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpentstring

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSecondsinteger

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

updatedstring date-time

The datetime on which the worklog was last updated.