---
title: "Get worklogs"
method: POST
path: "/rest/api/3/worklog/list"
tags: ["Issue worklogs"]
---

# Get worklogs

`POST /rest/api/3/worklog/list`

Returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

**[Permissions](#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.

## Query parameters

- `expand` string

## Request body

- WorklogIdsRequestBean
  - `ids` integer[], required — A list of worklog IDs.

## Response `200`

Returned if the request is successful.

- Worklog[]
  - `author` UserDetails — User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.
    - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
    - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
    - `active` boolean — Whether the user is active.
    - `avatarUrls` AvatarUrlsBean
      - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
      - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
      - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
      - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
    - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
    - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
    - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `self` string — The URL of the user.
    - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
  - `comment` unknown
  - `created` string, date-time — The datetime on which the worklog was created.
  - `id` string — The ID of the worklog record.
  - `issueId` string — The ID of the issue this worklog is for.
  - `properties` EntityProperty[] — Details of properties for the worklog. Optional when creating or updating a worklog.
    - `key` string — The key of the property. Required on create and update.
    - `value` unknown
  - `self` string, uri — The URL of the worklog item.
  - `started` string, date-time — The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
  - `timeSpent` string — 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 — 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` UserDetails — User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.
    - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
    - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
    - `active` boolean — Whether the user is active.
    - `avatarUrls` AvatarUrlsBean
      - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
      - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
      - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
      - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
    - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
    - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
    - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
    - `self` string — The URL of the user.
    - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
  - `updated` string, date-time — The datetime on which the worklog was last updated.
  - `visibility` Visibility — The group or role to which this item is visible.
    - `identifier` string, nullable — The ID of the group or the name of the role that visibility of this item is restricted to.
    - `type` 'group' | 'role' — Whether visibility of this item is restricted to a group or role.
    - `value` string — 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`.

## Other responses

- `400` — Returned if the request contains more than 1000 worklog IDs or is empty.
- `401` — Returned if the authentication credentials are incorrect or missing.

---

[API](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-3.md) · [All operations](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-3/revisions/bb8ae315642f/schema)