(Beta) Get a list of Micro-Integration Definitions

Lists the Micro-Integration Definitions of your organization. Each item carries the Definition's identity only: it does not embed its Connection or Workflow composition. The latest version and Connection ids are available from GET /microIntegrationDefinitions/{id}.

The Micro-Integration type and the environment filters match the Connection of the Definition's current version.



Token Permissions: [ micro_integrations:get:* ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filters results to Definitions whose name contains this value.

string

Filters results to Definitions whose current version uses one of these Micro-Integration types.

states
array of strings

Filters results to Definitions in one of these states: deploying, running, undeploying or undeployed. The state is calculated from the Definition's deployment requests.

states
Allowed:
string

Filters results to Definitions created by one of these users.

string

Filters results to Definitions whose current version is in one of these environments.

boolean
Defaults to false

When true, deleted Micro-Integration Definitions are included and flagged as deleted. Defaults to false.

string

Pass deployment to add the deployment summary of each Definition: its state (deploying, running, undeploying or undeployed), the version now deployed, whether it can be deleted and its latest deployment request. Pass latestVersion to add latestVersionSummary, a summary of its latest version: the version id and number, the Micro-Integration type, environment and event broker of its Connection, and the number of Flows. Comma-separated, so both can be passed. Unrecognised values are ignored.

string

Sorts results. Format: {field}:{asc|desc}. Sortable fields: name, createdTime, updatedTime. Defaults to name:asc.

integer
≥ 1
Defaults to 100

The number of Definitions to return per page.

integer
≥ 1
Defaults to 1

The page number to retrieve.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*