Sign in
latestOpenAPI 3.0.02026-08-107797148.2 KB

89261af4dd80

Flows

List Flows

List all process flows associated with your company profile.

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

  • latestVersion
  • latestVersion_count
  • latestVersionExists
  • latestVersion.variables
  • deployedVersion
  • deployedVersion_count
  • deployedVersionExists
  • deployedVersion.variables
  • currentVersion
  • currentVersion_count
  • currentVersionExists
  • currentVersion.latestRun
  • currentVersion.steps
  • currentVersion.steps.connector
  • currentVersion.steps.connector.authenticationImplementation
  • currentVersion.steps.connector.authenticationImplementation.system
  • currentVersion.steps.variables
  • currentVersion.steps.cache
  • currentVersion.steps.dataPool
  • currentVersion.steps.scriptVersion
  • currentVersion.steps.scriptVersion.script
  • currentVersion.schedules
  • currentVersion.variables
  • versions
  • versions_count
  • versionsExists
  • versions.schedules
  • versions.variables
  • versions.deployedByUser
  • labels
  • labels_count
  • labelsExists
  • webhooks
  • webhooks_count
  • webhooksExists
  • callbacks
  • callbacks_count
  • callbacksExists
  • notificationGroups
  • notificationGroups_count
  • notificationGroupsExists
  • messageBrokers
  • messageBrokers_count
  • messageBrokersExists
  • messageBrokerQueues
  • messageBrokerQueues_count
  • messageBrokerQueuesExists
  • deployments
  • deployments_count
  • deploymentsExists
  • deployments.virtualEnvironment
  • deployments.flowVersion
  • deployments.package
  • deployments.enabledBy

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

  • name
  • marketplace_app_id
  • labelled
  • enabled
  • deployed

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

  • flows.id
  • flows.name
  • flows.enabled_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

  • name
  • enabled_at
  • created_at
  • id
get/api/v1/flows

Query parameters

filter[name]string

Filter results by name.

filter[marketplace_app_id]string

Filter results by marketplace_app_id.

filter[blueprint_id]string

Filter results by blueprint_id.

filter[blueprint_version_number]string

Filter results by blueprint_version_number.

filter[labelled]string

Filter results by label id.

filter[enabled]string

Filter results by enabled.

filter[deployed]string

Filter results by deployed.

filter[versions.id]string

Filter results by versions.id.

filter[,]string

Filter results by ,.

filter[versions]string

Filter results by versions.

filter[id]string

Filter results by id.

includestring

Comma-separated list of relationships to include. Available: latestVersion, latestVersion.variables, deployedVersion, deployedVersion.variables, latestDeployedVersion, latestDeployedVersion.variables, latestDeployedVersion.steps.connector.authenticationImplementation.system, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion.script, latestDeployedVersion.steps.scriptVersion.script, latestDeployedVersion.steps.cache, latestDeployedVersion.steps.dataPool, deployedVersion.steps.connector.authenticationImplementation.system, deployedVersion.steps.connector.authenticationImplementation.system.endpoints, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script

sortstring

Sort field. Prefix with - for descending. Available: name, enabled_at, created_at, id

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

Response

Successful response