Get worklogs - JIRA 7.6.1

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.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/worklog/list' \ --header 'Content-Type: application/json' \ --data-raw '{ "ids": [ 1, 2, 5, 10 ] }'

[{"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

Query Params

expand

string

optional

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

Body Params application/json

ids

array[integer <int64>]

required

A list of worklog IDs.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

array of:

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.

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

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.

identifier

string | null

optional

The ID of the group or the name of the role that visibility of this item is restricted to.

type

enum<string>

optional

Whether visibility of this item is restricted to a group or role.

Allowed values:

grouprole

value

string

optional

The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

🟠400Returned if the request contains more than 1000 worklog IDs or is empty.

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