---
title: "Get changelogs"
method: GET
path: "/rest/api/2/issue/{issueIdOrKey}/changelog"
tags: ["Issues"]
---

# Get changelogs

`GET /rest/api/2/issue/{issueIdOrKey}/changelog`

Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

 *  *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.

## Path parameters

- `issueIdOrKey` string, required

## Query parameters

- `startAt` integer
- `maxResults` integer

## Response `200`

Returned if the request is successful.

- PageBeanChangelog — A page of items.
  - `isLast` boolean — Whether this is the last page.
  - `maxResults` integer — The maximum number of items that could be returned.
  - `nextPage` string, uri — If there is another page of results, the URL of the next page.
  - `self` string, uri — The URL of the page.
  - `startAt` integer — The index of the first item returned.
  - `total` integer — The number of items returned.
  - `values` Changelog[] — The list of items.
    - `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.
    - `created` string, date-time — The date on which the change took place.
    - `historyMetadata` HistoryMetadata — Details of issue history metadata.
      - `activityDescription` string — The activity described in the history record.
      - `activityDescriptionKey` string — The key of the activity described in the history record.
      - `actor` HistoryMetadataParticipant — Details of user or system associated with a issue history metadata item.
        - `avatarUrl` string — The URL to an avatar for the user or system associated with a history record.
        - `displayName` string — The display name of the user or system associated with a history record.
        - `displayNameKey` string — The key of the display name of the user or system associated with a history record.
        - `id` string — The ID of the user or system associated with a history record.
        - `type` string — The type of the user or system associated with a history record.
        - `url` string — The URL of the user or system associated with a history record.
      - `cause` HistoryMetadataParticipant — Details of user or system associated with a issue history metadata item.
        - `avatarUrl` string — The URL to an avatar for the user or system associated with a history record.
        - `displayName` string — The display name of the user or system associated with a history record.
        - `displayNameKey` string — The key of the display name of the user or system associated with a history record.
        - `id` string — The ID of the user or system associated with a history record.
        - `type` string — The type of the user or system associated with a history record.
        - `url` string — The URL of the user or system associated with a history record.
      - `description` string — The description of the history record.
      - `descriptionKey` string — The description key of the history record.
      - `emailDescription` string — The description of the email address associated the history record.
      - `emailDescriptionKey` string — The description key of the email address associated the history record.
      - `extraData` object — Additional arbitrary information about the history record.
      - `generator` HistoryMetadataParticipant — Details of user or system associated with a issue history metadata item.
        - `avatarUrl` string — The URL to an avatar for the user or system associated with a history record.
        - `displayName` string — The display name of the user or system associated with a history record.
        - `displayNameKey` string — The key of the display name of the user or system associated with a history record.
        - `id` string — The ID of the user or system associated with a history record.
        - `type` string — The type of the user or system associated with a history record.
        - `url` string — The URL of the user or system associated with a history record.
      - `type` string — The type of the history record.
    - `id` string — The ID of the changelog.
    - `items` ChangeDetails[] — The list of items changed.
      - `field` string — The name of the field changed.
      - `fieldId` string — The ID of the field changed.
      - `fieldtype` string — The type of the field changed.
      - `from` string — The details of the original value.
      - `fromString` string — The details of the original value as a string.
      - `to` string — The details of the new value.
      - `toString` string — The details of the new value as a string.

## Other responses

- `404` — Returned if the issue is not found or the user does not have permission to view it.

---

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