Skip to content

Function: getBulkChangelogs() ​

ts
function getBulkChangelogs(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  issueChangeLogs?: object[];
  nextPageToken?: string | null;
}>;

Defined in: src/cloud/api/issues.ts:54

Bulk fetch changelogs for multiple issues and filter by fields

Returns a paginated list of all changelogs for given issues sorted by changelog date and issue IDs, starting from the oldest changelog and smallest issue ID.

Issues are identified by their ID or key, and optionally changelogs can be filtered by their field IDs. You can request the changelogs of up to 1000 issues and can filter them by up to 10 field IDs.

Permissions required:

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ fieldIds?: string[]; issueIdsOrKeys: string[]; maxResults?: number; nextPageToken?: string; }-
parameters.fieldIds?string[]List of field IDs to filter changelogs
parameters.issueIdsOrKeys?string[]List of issue IDs/keys to fetch changelogs for
parameters.maxResults?numberThe maximum number of items to return per page
parameters.nextPageToken?stringThe cursor for pagination
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; issueChangeLogs?: object[]; nextPageToken?: string | null; }>