FlowMate

FlowMate API

FlowMate API as documented publicly: 15 operations. Contract generated from the documentation by API Evangelist (2026-10-20); not the provider's own document.

GitHub OpenAPI

Operations 15

DELETE /flows DELETE /flows #
GET /flows GET /flows #
PATCH /flows PATCH /flows #
GET /flows/ Find Flow by ID - FlowMate API Documentation #
DELETE /flows/{id} Deletes a flow #
GET /flows/{id} Find Flow by ID - FlowMate API Documentation #
PATCH /flows/{id} Update an existing flow #
POST /flows/{id}/start Start a flow #
POST /flows/{id}/stop Stops the flow's integration process by publishing an appropriate event to the event bus. #
POST /login POST /login #
GET /templates GET /templates #
GET /users GET /users #
POST /users POST /users #
GET /users/ User get all users #
GET /users/{id} get a user by id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/flowmate/openapi/_ae-authored/flowmate-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-get-users-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-post-users-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-post-users-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-get-users-id-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-get-users-response2-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowmate/json-schema/flowmate-delete-flows-id-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/flowmate/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flowmate:flowmate-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flowmate-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: FlowMate API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 15 operation(s) read from 15 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; FlowMate has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 13
    documentation: 2
    pages-with-code: 15
    pages-read: 15
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://api.flowmate.io
  - https://api.flowmate.io/retrieve-all-flows-13164031e0
  - https://api.flowmate.io/find-flow-by-id-13164033e0
  - https://api.flowmate.io/deletes-a-flow-13164034e0
  - https://api.flowmate.io/update-an-existing-flow-13164035e0
  - https://api.flowmate.io/bulk-update-a-number-of-existing-flows-13164036e0
  - https://api.flowmate.io/start-a-flow-13164037e0
  - https://api.flowmate.io/stop-a-flow-13164038e0
  - https://api.flowmate.io/start-multiple-flows-13164039e0
  - https://api.flowmate.io/stop-multiple-flows-13164040e0
  - https://api.flowmate.io/get-all-users-13164066e0
  - https://api.flowmate.io/create-user-13164067e0
  - https://api.flowmate.io/get-a-user-by-id-13164068e0
  - https://api.flowmate.io/get-current-user-13164072e0
  - https://api.flowmate.io/retrieve-all-flow-templates-13164091e0
paths:
  /flows:
    delete:
      operationId: delete_flows
      tags:
      - Flows
      summary: DELETE /flows
      x-source: https://api.flowmate.io/deletes-a-flow-13164034e0
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl cURL-Windows Httpie wget PowerShell curl --location --request DELETE ''https://api.platform.openintegrationhub.com/flows/''  --header
          ''Authorization: Bearer <token>'' Responses 🟢 200 OK application/json Flow was successfully deleted Body application/json Generate Code
          Example { } 🟠 400 Bad Request 🟠 404 Record Not Found 🟠 409 409 Modified at   2025-01-16 10:16:12 Previous Find Flow by ID Next Up'
    get:
      operationId: get_flows
      tags:
      - Flows
      summary: GET /flows
      x-source: https://api.flowmate.io/retrieve-all-flows-13164031e0
      parameters:
      - name: filter[status]
        in: query
        required: false
        schema:
          type: string
      - name: filter[type]
        in: query
        required: false
        schema:
          type: string
      - name: filter[user]
        in: query
        required: false
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl cURL-Windows Httpie wget PowerShell curl --location --globoff ''https://api.platform.openintegrationhub.com/flows?page[size]=undefined&page[number]=undefined&filter[status]=undefined&filter[type]=undefined&filter[user]=undefined&sort=undefined&search=undefined''  --header
          ''Authorization: Bearer <token>'' Responses 🟢 200 OK application/json A list of flows. Body application/json Generate Code Exa'
    patch:
      operationId: patch_flows
      tags:
      - Flows
      summary: PATCH /flows
      x-source: https://api.flowmate.io/update-an-existing-flow-13164035e0
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl cURL-Windows Httpie wget PowerShell curl --location --request PATCH 'https://api.platform.openintegrationhub.com/flows/'\
          \  --header 'Authorization: Bearer <token>'  --header 'Content-Type: application/json'  --data '{\n \"name\": \"SnazzyToCodeComponent\"\
          ,\n \"description\": \"This flow polls for persons and posts them on webhoo.site.\",\n \"tenant\": \"string\",\n \"graph\": {\n \"nodes\"\
          : [\n [\n {\n \"id\": \"step_1\""
  /flows/:
    get:
      operationId: get_flows
      tags:
      - Flows
      summary: Find Flow by ID - FlowMate API Documentation
      description: Retrieve all flows.
      x-source: https://api.flowmate.io/find-flow-by-id-13164033e0
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowsResponse'
      x-evidence:
        kind: documentation
  /flows/{id}:
    delete:
      operationId: delete_flows_id
      tags:
      - Flows
      summary: Deletes a flow
      description: Entirely deletes a Flow from the repository. This cannot be reverted. Requires the 'flows.write' permission.
      x-source: https://api.flowmate.io/deletes-a-flow-13164034e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFlowsIdResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_flows_id
      tags:
      - Flows
      summary: Find Flow by ID - FlowMate API Documentation
      description: Returns a single Flow by its ID, if the user is authorized to see it. This requires the 'flows.read' permission.
      x-source: https://api.flowmate.io/find-flow-by-id-13164033e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowsIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_flows_id
      tags:
      - Flows
      summary: Update an existing flow
      description: The id is used to match the existing Flow that will be updated. Requires the 'flows.write' permission.
      x-source: https://api.flowmate.io/update-an-existing-flow-13164035e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchFlowsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchFlowsIdResponse'
      x-evidence:
        kind: documentation
  /flows/{id}/start:
    post:
      operationId: post_flows_id_start
      tags:
      - Flows
      summary: Start a flow
      description: Initiates the flow's integration process by publishing an appropriate event to the event bus. Requires the 'flows.control'
        permission.
      x-source: https://api.flowmate.io/start-a-flow-13164037e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFlowsIdStartResponse'
      x-evidence:
        kind: documentation
  /flows/{id}/stop:
    post:
      operationId: post_flows_id_stop
      tags:
      - Flows
      summary: Stops the flow's integration process by publishing an appropriate event to the event bus.
      x-source: https://api.flowmate.io/stop-a-flow-13164038e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFlowsIdStopResponse'
      x-evidence:
        kind: documentation
  /login:
    post:
      operationId: post_login
      tags:
      - Login
      summary: POST /login
      x-source: https://api.flowmate.io
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostLoginRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostLoginResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl cURL-Windows Httpie wget PowerShell curl --location 'https://api.platform.openintegrationhub.com/login'  --header 'Authorization:\
          \ Bearer <token>'  --header 'Content-Type: application/json'  --data '{\n \"username\": \"string\",\n \"password\": \"string\"\n}' Responses\
          \ \U0001F7E2 200 OK application/json Login successful Body application/json Generate Code Example { \n \"token\" : \"string\" , \n \"\
          id\" : \"string\" \n } \U0001F7E0 4"
  /templates:
    get:
      operationId: get_templates
      tags:
      - Templates
      summary: GET /templates
      x-source: https://api.flowmate.io/retrieve-all-flow-templates-13164091e0
      parameters:
      - name: filter[status]
        in: query
        required: false
        schema:
          type: string
      - name: filter[user]
        in: query
        required: false
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      - name: tags
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl cURL-Windows Httpie wget PowerShell curl --location --globoff ''https://api.platform.openintegrationhub.com/templates?page[size]=undefined&page[number]=undefined&filter[status]=undefined&filter[user]=undefined&sort=undefined&search=undefined&tags=undefined''  --header
          ''Authorization: Bearer <token>'' Responses 🟢 200 OK application/json A list of flow templates. Body application/json Generate Cod'
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: GET /users
      x-source: https://api.flowmate.io/get-all-users-13164066e0
      parameters:
      - name: meta
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl cURL-Windows Httpie wget PowerShell curl --location 'https://api.platform.openintegrationhub.com/users?meta=undefined'\
          \  --header 'Authorization: Bearer <token>' Responses \U0001F7E2 200 OK application/json List all users Body application/json Generate\
          \ Code Example [ \n { \n \"id\" : \"string\" , \n \"username\" : \"string\" , \n \"firstname\" : \"string\" , \n \"lastname\" : \"string\"\
          \ , \n \"status\" : \"ACTIVE\" , \n \"tenant\""
    post:
      operationId: post_users
      tags:
      - Users
      summary: POST /users
      x-source: https://api.flowmate.io/create-user-13164067e0
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostUsersRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostUsersResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl cURL-Windows Httpie wget PowerShell curl --location 'https://api.platform.openintegrationhub.com/users'  --header 'Authorization:\
          \ Bearer <token>'  --header 'Content-Type: application/json'  --data '{\n \"id\": \"string\",\n \"username\": \"string\",\n \"firstname\"\
          : \"string\",\n \"lastname\": \"string\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"string\",\n \"roles\": [\n {\n \"id\": \"string\"\
          ,\n \"name\": \"string\",\n \"permissions\":"
  /users/:
    get:
      operationId: get_users
      tags:
      - Users
      summary: User get all users
      x-source: https://api.flowmate.io/get-a-user-by-id-13164068e0
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersResponse2'
      x-evidence:
        kind: documentation
  /users/{id}:
    get:
      operationId: get_users_id
      tags:
      - Users
      summary: get a user by id
      x-source: https://api.flowmate.io/get-a-user-by-id-13164068e0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetFlowsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of Flow objects
        meta:
          type: object
          description: Metadata
    DeleteFlowsIdResponse:
      type: object
      properties:
        '200':
          type: string
          description: Flow was successfully deleted
        '400':
          type: string
          description: Bad Request
        '404':
          type: string
          description: Record Not Found
        '409':
          type: string
          description: Conflict
    GetFlowsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Flow object
        meta:
          type: object
          description: Metadata
    PatchFlowsIdRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        tenant:
          type: string
        graph:
          type: object
        type:
          type: string
        cron:
          type: string
        owners:
          type: array
    PatchFlowsIdResponse:
      type: object
      properties:
        data:
          type: object
        meta:
          type: object
    PostFlowsIdStartResponse:
      type: object
      properties:
        data.id:
          type: string
          description: The flow id
        data.status:
          type: string
          description: The new status of the flow
    PostFlowsIdStopResponse:
      type: object
      properties:
        data.id:
          type: string
          description: ID of the stopped flow
        data.status:
          type: string
          description: New status of the flow (e.g., "stopping")
    PostLoginRequest:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
    PostLoginResponse:
      type: object
      properties:
        token:
          type: string
        id:
          type: string
    GetUsersResponse:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        status:
          type: string
        tenant:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              permissions:
                type: array
                items:
                  type: string
              scope:
                type: string
              createdAt:
                type: string
              updatedAt:
                type: string
              isGlobal:
                type: boolean
              description:
                type: string
        permissions:
          type: array
          items:
            type: string
        confirmed:
          type: boolean
        img:
          type: string
    PostUsersRequest:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        status:
          type: string
        tenant:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              permissions:
                type: array
                items:
                  type: string
              scope:
                type: string
              createdAt:
                type: string
              updatedAt:
                type: string
              isGlobal:
                type: boolean
              description:
                type: string
        permissions:
          type: array
          items:
            type: string
        confirmed:
          type: boolean
        img:
          type: string
    PostUsersResponse:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        status:
          type: string
        tenant:
          type: string
        roles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              permissions:
                type: array
                items:
                  type: string
              scope:
                type: string
              createdAt:
                type: string
              updatedAt:
                type: string
              isGlobal:
                type: boolean
              description:
                type: string
        permissions:
          type: array
          items:
            type: string
        confirmed:
          type: boolean
        img:
          type: string
    GetUsersResponse2:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        status:
          type: string
        tenant:
          type: string
        roles:
          type: array
          description: array of role objects
        permissions:
          type: array
          description: array of permission strings
        confirmed:
          type: boolean
        img:
          type: string
    GetUsersIdResponse:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        status:
          type: string
        tenant:
          type: string
        roles:
          type: array
          description: array of role objects
        permissions:
          type: array
          description: array of permission strings
        confirmed:
          type: boolean
        img:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Flows
- name: Login
- name: Templates
- name: Users