Atlassian: Get changelogs

← Issues operations · Get started

Operation atlassian.getchangelogs

Provider route: GET /{cloudId}/rest/api/3/issue/{issueIdOrKey}/changelog. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issues"]["getChangeLogs"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issues.getChangeLogs(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issues.get_change_logs(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.issueIdOrKey	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.startAt	integer	Optional	Default: 0 Format: int32
query.maxResults	integer	Optional	Default: 100 Format: int32

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get changelogs — response body

Referenced models: Get changelogs — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Get changelogs — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of items.
isLast	JSON	Optional
isLast (anyOf 1)	boolean	Alternative	Whether this is the last page. Read only: true
isLast (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of items that could be returned. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
nextPage	JSON	Optional
nextPage (anyOf 1)	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
nextPage (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the page. Format: uri Read only: true
self (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The number of items returned. Format: int64 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative
values	JSON	Optional
values (anyOf 1)	array	Alternative	The list of items. Read only: true
values (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item
values (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item

Get changelogs — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
author	JSON	Optional
author (anyOf 1)	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The user who made the change. Read only: true
author (anyOf 2)	null	Alternative
created	JSON	Optional
created (anyOf 1)	JSON	Alternative
created (anyOf 1) (anyOf 1)	string	Alternative	The date on which the change took place. Read only: true
created (anyOf 1) (anyOf 2)	integer	Alternative
created (anyOf 2)	null	Alternative
historyMetadata	JSON	Optional
historyMetadata (anyOf 1)	Model	Alternative	Expand Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata The history metadata associated with the changed. Read only: true
historyMetadata (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the changelog. Read only: true
id (anyOf 2)	null	Alternative
items	JSON	Optional
items (anyOf 1)	array	Alternative	The list of items changed. Read only: true
items (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item items The list of items changed item
items (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item items The list of items changed item, Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone

Get changelogs — response body — values The list of items item items The list of items changed item

Field	Type	Presence	Description and constraints
$	object	Root	A change item.
field	JSON	Optional
field (anyOf 1)	string	Alternative	The name of the field changed. Read only: true
field (anyOf 2)	null	Alternative
fieldId	JSON	Optional
fieldId (anyOf 1)	string	Alternative	The ID of the field changed. Read only: true
fieldId (anyOf 2)	null	Alternative
fieldtype	JSON	Optional
fieldtype (anyOf 1)	string	Alternative	The type of the field changed. Read only: true
fieldtype (anyOf 2)	null	Alternative
from	JSON	Optional
from (anyOf 1)	string	Alternative	The details of the original value. Read only: true
from (anyOf 2)	null	Alternative
fromString	JSON	Optional
fromString (anyOf 1)	string	Alternative	The details of the original value as a string. Read only: true
fromString (anyOf 2)	null	Alternative
to	JSON	Optional
to (anyOf 1)	string	Alternative	The details of the new value. Read only: true
to (anyOf 2)	null	Alternative
toString	JSON	Optional
toString (anyOf 1)	string	Alternative	The details of the new value as a string. Read only: true
toString (anyOf 2)	null	Alternative

Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url

Field	Type	Presence	Description and constraints
$	object	Root	Details of user or system associated with a issue history metadata item. Additional keys: allowed
avatarUrl	JSON	Optional
avatarUrl (anyOf 1)	string	Alternative	The URL to an avatar for the user or system associated with a history record.
avatarUrl (anyOf 2)	null	Alternative
displayName	JSON	Optional
displayName (anyOf 1)	string	Alternative	The display name of the user or system associated with a history record.
displayName (anyOf 2)	null	Alternative
displayNameKey	JSON	Optional
displayNameKey (anyOf 1)	string	Alternative	The key of the display name of the user or system associated with a history record.
displayNameKey (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the user or system associated with a history record.
id (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the user or system associated with a history record.
type (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative	The URL of the user or system associated with a history record.
url (anyOf 2)	null	Alternative

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
$	object	Root
16x16	JSON	Optional
16x16 (anyOf 1)	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
16x16 (anyOf 2)	null	Alternative
24x24	JSON	Optional
24x24 (anyOf 1)	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
24x24 (anyOf 2)	null	Alternative
32x32	JSON	Optional
32x32 (anyOf 1)	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
32x32 (anyOf 2)	null	Alternative
48x48	JSON	Optional
48x48 (anyOf 1)	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
48x48 (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getchangelogs. Catalog operation: getChangeLogs. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source