v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Workflow transition rules

Get workflow transition rule configurations

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

  • of one or more transition rule types, such as workflow post functions.
  • matching one or more transition rule keys.

Only workflows containing transition rules created by the calling Connect or Forge app are returned.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect or Forge apps can use this operation.

get/rest/api/2/workflow/rule/config

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

typesstring[] required

The types of the transition rules to return.

keysstring[]

The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.

workflowNamesstring[]

The list of workflow names to filter by.

withTagsstring[]

The list of tags to filter by.

draftboolean

Deprecated: Whether draft or published workflows are returned. If not provided, both workflow types are returned. The 'draft' parameter will be removed from this API on November 2, 2026.

expandstring

Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.