jira.js
    Preparing search index...

    Function getAvailableTransitions

    • Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk transition operations. You can submit either single or multiple issues in the query to obtain the available transitions.

      The response will provide the available transitions for issues, organized by their respective workflows. Only the transitions that are common among the issues within that workflow and do not involve any additional field updates will be included. For bulk transitions that require additional field updates, please utilise the Jira Cloud UI.

      You can request available transitions for up to 1,000 issues in a single operation. This API uses pagination to return responses, delivering 50 workflows at a time.

      Permissions required:

      Parameters

      • client: Client
      • parameters: { endingBefore?: string; issueIdsOrKeys: string; startingAfter?: string }
        • OptionalendingBefore?: string

          (Optional)The end cursor for use in pagination.

        • issueIdsOrKeys: string

          Comma (,) separated Ids or keys of the issues to get transitions available for them.

        • OptionalstartingAfter?: string

          (Optional)The start cursor for use in pagination.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              availableTransitions?: {
                  issues?: string[];
                  isTransitionsFiltered?: boolean;
                  transitions?: {
                      to?: {
                          statusId?: (...)
                          | (...);
                          statusName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      transitionId?: number;
                      transitionName?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              }[];
              endingBefore?: string;
              startingAfter?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility