Get issue worklogs - JIRA 7.6.1

Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required: Workloads are only returned where the user has:

Browse projects project permission for the project that the issue is in.

If issue-level security is configured, issue-level security permission to view the issue.

If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

{ "startAt": 0, "maxResults": 1, "total": 1, "worklogs": [ { "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000", "author": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "updateAuthor": { "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "accountId": "5b10a2844c20165700ede21g", "displayName": "Mia Krystof", "active": false }, "comment": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "I did some work here." } ] } ] }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "type": "group", "value": "jira-developers", "identifier": "276f955c-63d7-42c8-9520-92d01dca0625" }, "started": "2021-01-17T12:34:00.000+0000", "timeSpent": "3h 20m", "timeSpentSeconds": 12000, "id": "100028", "issueId": "10002" } ] }

Request

Path Params

issueIdOrKey

string

required

The ID or key of the issue.

Query Params

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

startedAfter

integer

optional

The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.

startedBefore

integer

optional

The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.

expand

string

optional

Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.

Responses

🟢200Returned if the request is successful

application/json

Body

Paginated list of worklog details

maxResults

integer <int32>

read-onlyoptional

The maximum number of results that could be on the page.

startAt

integer <int32>

read-onlyoptional

The index of the first item returned on the page.

total

integer <int32>

read-onlyoptional

The number of results on the page.

worklogs

array[object (Worklog) {14}]

read-onlyoptional

List of worklogs.

author

object

read-onlyoptional

Details of the user who created the worklog.

comment

optional

A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.

created

string <date-time>

read-onlyoptional

The datetime on which the worklog was created.

string

read-onlyoptional

The ID of the worklog record.

issueId

string

read-onlyoptional

The ID of the issue this worklog is for.

properties

array[object (EntityProperty) {2}]

optional

Details of properties for the worklog. Optional when creating or updating a worklog.

self

string <uri>

read-onlyoptional

The URL of the worklog item.

started

string <date-time>

optional

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

timeSpent

string

optional

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.

timeSpentSeconds

integer <int64>

optional

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.

updateAuthor

object

read-onlyoptional

Details of the user who last updated the worklog.

updated

string <date-time>

read-onlyoptional

The datetime on which the worklog was last updated.

visibility

object

optional

Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if: * the issue is not found or the user does not have permission to view the issue. * `startAt` or `maxResults` has non-numeric values. * time tracking is disabled.