# FlowMate API Documentation

## Docs
- [Executions](https://api.flowmate.io/executions-2437536f0.md): 

## API Docs
- Authentication [Login](https://api.flowmate.io/login-13164063e0.md): 
- Flows [Retrieve all flows](https://api.flowmate.io/retrieve-all-flows-13164031e0.md): This will only return Flows that are either directly associated with the user, or that are associated with a tenant that the user is also a member of. Requires the 'flows.read' permissions.
- Flows [Find Flow by ID](https://api.flowmate.io/find-flow-by-id-13164033e0.md): Returns a single Flow by its ID, if the user is authorized to see it. This requires the 'flows.read' permission
- Flows [Deletes a flow](https://api.flowmate.io/deletes-a-flow-13164034e0.md): Entirely deletes a Flow from the repository. This cannot be reverted. Requires the 'flows.write' permission.
- Flows [Update an existing flow](https://api.flowmate.io/update-an-existing-flow-13164035e0.md): The id is used to match the existing Flow that will be updated. Requires the 'flows.write' permission.
- Flows [Bulk update a number of existing flows](https://api.flowmate.io/bulk-update-a-number-of-existing-flows-13164036e0.md): Each object in the body must contain an id property to match it to the flow to be updated. Requires the 'flows.write' permission.
- Flows [Start a flow](https://api.flowmate.io/start-a-flow-13164037e0.md): Initiates the flow's integration process by publishing an appropriate event to the event bus. Requires the 'flows.control' permission.
- Flows [Stop a flow](https://api.flowmate.io/stop-a-flow-13164038e0.md): Stops the flow's integration process by publishing an appropriate event to the event bus. Requires the 'flows.control' permission.
- Flows [Start multiple flows](https://api.flowmate.io/start-multiple-flows-13164039e0.md): Initiates the flow's integration process by publishing the appropriate events to the event bus. Requires the 'flows.control' permission.
- Flows [Stop multiple flows](https://api.flowmate.io/stop-multiple-flows-13164040e0.md): Stops multiple flow's integration process by publishing an appropriate events to the event bus. Requires the 'flows.control' permission.
- User [get all users](https://api.flowmate.io/get-all-users-13164066e0.md): This can only be done by a logged in user who has the required privileges.
- User [Create user](https://api.flowmate.io/create-user-13164067e0.md): This can only be done by a logged in user who has the required privileges.
- User [get a user by id](https://api.flowmate.io/get-a-user-by-id-13164068e0.md): This can only be done by a logged in user who has the required privileges.
- User [get current user](https://api.flowmate.io/get-current-user-13164072e0.md): User must have a valid session.
- Templates [Retrieve all flow templates](https://api.flowmate.io/retrieve-all-flow-templates-13164091e0.md): This will only return Flow Templates that are either directly associated with the user, or that are associated with a tenant that the user is also a member of. Requires the 'flowTemplates.read' permissions.
- Templates [Add a new template to the repository](https://api.flowmate.io/add-a-new-template-to-the-repository-13164092e0.md): This requires the 'flowTemplates.write' permissions. The new Flow Template will automatically be associated with the current user in the owners array, allowing editing and viewing by this user irrespective of tenancies.
- Templates [Find Flow Template by ID](https://api.flowmate.io/find-flow-template-by-id-13164093e0.md): Returns a single Flow Template by its ID, if the user is authorized to see it. This requires the 'flowTemplates.read' permission
- Templates [Deletes a flow template](https://api.flowmate.io/deletes-a-flow-template-13164094e0.md): Entirely deletes a Flow Template from the repository. This cannot be reverted. Requires the 'flowTemplates.write' permission.
- Templates [Update an existing flow template](https://api.flowmate.io/update-an-existing-flow-template-13164095e0.md): The id is used to match the existing Flow Template that will be updated. Requires the 'flowTemplates.write' permission.
- Templates [Generate a flow from the flow template](https://api.flowmate.io/generate-a-flow-from-the-flow-template-13164096e0.md): Creates a flow based on the settings in the flow template. Requires the 'flows.write' permission.
- Executions [Get Executions](https://api.flowmate.io/get-executions-11535731e0.md): This endpoint returns the total count of executions for a specified flow, user or connector. It provides a simple way to monitor and retrieve the number of times a particular flow has been executed. Useful for tracking flow usage, analyzing performance metrics, and managing flow lifecycle events.
- Webhooks [Incoming Webhook](https://api.flowmate.io/incoming-webhook-13164342e0.md): Within your system’s webhook functionality, create and configure a webhook to send relevant data as a POST request to the webhook url using the user’s flow ID.