Skip to content

Function: getChangeLogs() ​

ts
function getChangeLogs(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

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

Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.

This operation can be accessed anonymously.

Permissions required:

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ issueIdOrKey: string; maxResults?: number; startAt?: number; }-
parameters.issueIdOrKeystringThe ID or key of the issue.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>