# Synatic Flows API

**Canonical:** https://apis.io/apis/synatic/synatic-flows-api/  
**Provider:** Synatic — https://apis.io/providers/synatic/  
**Base URL:** https://api.synatic.com  
**Documentation:** https://api.synatic.com/swagger.json

Synatic Flows API is one of 37 APIs that [Synatic](https://apis.io/providers/synatic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Flows. The published artifact set on APIs.io includes an OpenAPI specification.

A Flow defines a specific end to end process that can be executed at any time

## Operations (60 of 98)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/organizations(?:/([^/]+?))/flows/usedby` | Queries the flows that use a certain items |
| GET | `/v1/organizations(?:/([^/]+?))/flows/common-steps` | Returns an array of commonly used steps |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/full` | Updates a flow full |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/watchFiles` | Gets the flows watch files |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs` | Queries the Runs for the Flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs` | Executes a Flow and creates a run |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/validations` | Retrieves validations for the flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/validate-step` | Validates the step |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/steps` | Saves the steps |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/insert` | Inserts a step into the flow map |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/control-step/swap/{swapOption}` | Swaps a control step in the flow |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/control-step/copy` | Gets the copied control step |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/control-step/copy/add` | Adds a copied control step to the flow |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/steps/{mapStepId}` | Updates a step in the map |
| DELETE | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/steps/{mapStepId}` | Deletes a step in the map |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/returns/{endStepId}` | Updates the returns in a subflow |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/{subFlowStepId}/parentField/{field}` | Updates the returns in a subflow |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/{startStepId}/properties` | Updates the subflow properties |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/map` | Saves the Steps Map |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/flowTriggers` | Saves the Flow Triggers |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs/stats` | Gets the Run stats for a Flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs/stats/{targetDate}` | Gets the Run stats for a Flow for a specific target date |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/export` | Export a Flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/import` | Imports a flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/import/update` | Imports a flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/parentFlows` | Get the Parent Flows |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs/{runId}` | Retrieves a Run for a flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/copy` | Copies a flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/checkStepsAllowed` | Checks flow for blacklisted steps |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/execute` | Executes a Flow and creates a run |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/execute` | Executes a synchronous Flow and returns the results |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/test/{toMapStepId}` | Runs a flow without source and destination as a test |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/purge` | Purges flow items like runes, records and events |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/resetSequence` | Resets a Flows sequence number |
| DELETE | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/records` | Deletes all the Run Records associated with this Flow |
| DELETE | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/steps/{stepId}` | Deletes a specific step |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/records/clean` | Cleans all the Run Records associated with this Flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions` | Queries a Flows Versions |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions` | Commits a new version of a Flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}` | Returns a version of a Flow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/checkout` | Checks out a version of a FLow |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/deploy` | Deploys a version of a flow that will run by default when a flow is run |
| POST | `/v1/organizations(?:/([^/]+?))/flows/{flowId}/discard-changes` | Discard changes on a flow and checks out the last deployed version |
| GET | `/v1/organizations(?:/([^/]+?))/flows` | Queries the Flows |
| POST | `/v1/organizations(?:/([^/]+?))/flows` | Creates a Flow |
| GET | `/v1/organizations(?:/([^/]+?))/flows/{flowId}` | Retrieves a Flow |
| PUT | `/v1/organizations(?:/([^/]+?))/flows/{flowId}` | Updates a Flow |
| DELETE | `/v1/organizations(?:/([^/]+?))/flows/{flowId}` | Deletes a Flow |
| PATCH | `/v1/organizations(?:/([^/]+?))/flows/{flowId}` | Patches a Flow given the JSON Patch |
| GET | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/usedby` | Queries the flows that use a certain items |
| GET | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/common-steps` | Returns an array of commonly used steps |
| PUT | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/full` | Updates a flow full |
| GET | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/watchFiles` | Gets the flows watch files |
| GET | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs` | Queries the Runs for the Flow |
| POST | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs` | Executes a Flow and creates a run |
| GET | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/validations` | Retrieves validations for the flow |
| POST | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/validate-step` | Validates the step |
| POST | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/steps` | Saves the steps |
| POST | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/insert` | Inserts a step into the flow map |
| PUT | `/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/control-step/swap/{swapOption}` | Swaps a control step in the flow |

…and 38 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/synatic/openapi/synatic-flows-api-openapi.yml

## Other Synatic APIs (12)

- [Synatic Agency Fuse Ams360 Webhooks API](https://apis.io/apis/synatic/synatic-agencyfuseams360webhooks-api/)
- [Synatic Agency Fuse Assist API Keys API](https://apis.io/apis/synatic/synatic-agencyfuseassistapikeys-api/)
- [Synatic API Keys API](https://apis.io/apis/synatic/synatic-api-keys-api/)
- [Synatic Billing API](https://apis.io/apis/synatic/synatic-billing-api/)
- [Synatic Buffers API](https://apis.io/apis/synatic/synatic-buffers-api/)
- [Synatic Change Logs API](https://apis.io/apis/synatic/synatic-changelogs-api/)
- [Synatic Comments API](https://apis.io/apis/synatic/synatic-comments-api/)
- [Synatic Content API](https://apis.io/apis/synatic/synatic-content-api/)
- [Synatic Data Stores API](https://apis.io/apis/synatic/synatic-datastores-api/)
- [Synatic Entity Sync API](https://apis.io/apis/synatic/synatic-entity-sync-api/)
- [Synatic Event Logs API](https://apis.io/apis/synatic/synatic-event-logs-api/)
- [Synatic Files API](https://apis.io/apis/synatic/synatic-files-api/)

## Tags

Flows

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/synatic/synatic-flows-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/synatic/.