provider Issue worklogs GET /rest/api/3/issue/{issueIdOrKey}/worklog
@utdk/jira /rest/api/3/issue/{issueIdOrKey}/worklog
Get issue worklogs
Returns worklogs for an issue (ordered by created time), 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](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** Workloads are only returned where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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.
issueIdOrKey path required
The ID or key of the issue.
string
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
startedAfter query
The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
integer
startedBefore query
The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
integer
expand query
Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getissueworklog
GET/rest/api/3/issue/{issueIdOrKey}/worklog
Returns worklogs for an issue (ordered by created time), 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](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** Workloads are only returned where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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.

Parameters

required

The ID or key of the issue.

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

The maximum number of items to return per page.

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

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

Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getissueworklog({
  "startAt": 0,
  "maxResults": 5000
})