MindCloud API Guides
All Endpoints Every MindCloud API endpoint on one page, by product and folder, each linked to its reference.
Every endpoint, 205 in all, by product and folder as the sidebar files them. Each links to its reference page: parameters, body, response fields, errors and an example. Every page is also served as Markdown: add .md to its address.
MindCloud What every MindCloud product runs on: your organization and who can do what in it, API keys, connections to other apps, and the Universal API.
Organization › Company Endpoint Request What it does List Companies GET /v2/companies Find the organization to work in: every organization your API key can act in, searchable with q=acme (any part of the name, or the exact id), with how the key reaches it. Get Company GET /v2/companies/{companyId} See your company in full: its region, parent organization, how many members and roles it has, and whether domain discovery and Embedded are on. Update Company PUT /v2/companies/{companyId} Change your company name, description, timezone, or logo, or turn domain discovery on or off.
Organization › Environments Endpoint Request What it does List Environments GET /v2/environments See your environments, like Production and Sandbox, and how many scheduled workflows target each one. Create Environment POST /v2/environments Add an environment, like Staging, to run workflows and map connections against. Update Environment PUT /v2/environments/{environmentId} Rename one of your environments. Delete Environment DELETE /v2/environments/{environmentId} Remove an environment nothing uses any more.
Organization › Parent and children Endpoint Request What it does Leave Parent Organization POST /v2/companies/{companyId}/leave-parent Stop being a child organization.
Organization › Parent and children › Child Organizations Organization › Parent and children › Link Requests Endpoint Request What it does List Link Requests GET /v2/link-requests See the requests to link your company with another organization: the ones you sent and the ones waiting for your answer. Create Link Request POST /v2/link-requests Ask an existing organization to become your child organization. Accept Link Request POST /v2/link-requests/{requestId}/accept Accept a request to link your company with another organization. Decline Link Request POST /v2/link-requests/{requestId}/decline Turn down a request to link your company with another organization. Cancel Link Request POST /v2/link-requests/{requestId}/cancel Withdraw a link request your company sent before the other organization answers it.
People and access › Members Endpoint Request What it does List Members GET /v2/members See who is in your company, the role they hold, and whether their invite is still pending. Get Member GET /v2/members/{userId} See one member: the role they hold, and whether they have accepted their invite. Update Member PUT /v2/members/{userId} Move a member to another role. Remove Member DELETE /v2/members/{userId} Remove someone from your company.
People and access › Invitations Endpoint Request What it does List Invitations GET /v2/invitations See who you invited and has not signed up yet. Get Invitation GET /v2/invitations/{invitationId} See one invitation that has not been accepted yet. Create Invitation POST /v2/invitations Invite someone by email. Resend Invitation POST /v2/invitations/{invitationId}/resend Send an invitation email again, for someone who lost or never got it. Revoke Invitation DELETE /v2/invitations/{invitationId} Take back an invitation that has not been accepted.
People and access › Roles Endpoint Request What it does List Roles GET /v2/roles See the roles you can assign, including the global roles MindCloud provides to every company. Get Role GET /v2/roles/{roleId} See exactly what one role lets its members do, permission by permission. Create Role POST /v2/roles Create a custom role with exactly the permissions you choose, then assign it to members. Update Role PUT /v2/roles/{roleId} Rename a custom role or replace its permissions. Delete Role DELETE /v2/roles/{roleId} Delete a custom role that no member holds any more.
People and access › Permissions Endpoint Request What it does List Permissions GET /v2/permissions See every permission you can build a role or an API key from, and which of them a custom role may carry. Get Member Permissions GET /v2/members/{userId}/permissions See exactly what one member can do, permission by permission, and why: from their role, a direct grant, or a company setting. Check Authorization POST /v2/authorization/check Find out whether someone can do something before they try, and which role, grant, or rule is behind the answer.
People and access › Teams Endpoint Request What it does List Teams GET /v2/teams See the teams in your company and who is on each one. Get Team GET /v2/teams/{teamId} See one team and who is on it. Create Team POST /v2/teams Create a team, then add people with Add Team Member and share connections with it. Update Team PUT /v2/teams/{teamId} Rename a team. Delete Team DELETE /v2/teams/{teamId} Delete a team. List Team Members GET /v2/teams/{teamId}/members See who is on a team, with their name, email, and role. Add Team Member POST /v2/teams/{teamId}/members Put someone on a team. Remove Team Member DELETE /v2/teams/{teamId}/members/{userId} Take someone off a team.
API keys Endpoint Request What it does Who Am I? GET /v2/me Check which API key you are calling with, which company your requests will read from, and which MindCloud capabilities that company has enabled.
API keys › Keys Endpoint Request What it does List API Keys GET /v2/api-keys Audit your API keys: when each was last used and which have been revoked. Get API Key GET /v2/api-keys/{apiKeyId} See one API key: what it may do, when it was last used, and whether it was revoked. Create API Key POST /v2/api-keys Create a new API key for your company. Update API Key PUT /v2/api-keys/{apiKeyId} Rename a key, or change what it may do. Revoke API Key DELETE /v2/api-keys/{apiKeyId} Revoke an API key so it stops working immediately.
API keys › Audit Events Endpoint Request What it does List Audit Events GET /v2/audit-events See what your company's API keys changed, and what they were refused.
Connections Endpoint Request What it does List Connections GET /v2/connections See the connections in your company and whether they still work: shared ones and your own personal ones, each app's default first. Get Connection GET /v2/connections/{connectionId} Check one connection's health, expiry, and metadata. List Connection Fields GET /v2/connections/fields See what connecting an app takes: each sign-in method, the app's default first, and the fields its form asks for. Create Connection POST /v2/connections Connect an app that signs in with typed-in values, such as an API key or a username and password. Create Connect Link POST /v2/connections/connect-links Connect an OAuth app (Google, Slack, HubSpot…), or reconnect an OAuth connection, through the person who owns the API key: they open the link signed in to MindCloud and sign in at the provider. Update Connection PUT /v2/connections/{connectionId} Rename a connection, make it your organization's default for its app, or share it with the organization (or make it yours alone). Update Connection Credentials PUT /v2/connections/{connectionId}/credentials Rotate an API key or password on a connection: send only the fields that change, from GET /v2/connections/fields. Test Connection POST /v2/connections/{connectionId}/test Check a connection against the provider it signs into. Delete Connection DELETE /v2/connections/{connectionId} Delete a connection, revoking it with the provider first when the app supports that.
Universal API › Discover Endpoint Request What it does List Universal Apps GET /v2/universal/apps Find published apps with Universal API actions. List Universal Actions GET /v2/universal/apps/{appSlug}/actions List the published actions for one app. Get Universal Action GET /v2/universal/apps/{appSlug}/actions/{actionSlug} Get one published action schema, including its arguments, response fields, and supported controls.
Universal API › Run Endpoint Request What it does Resolve Universal Lookup GET /v2/universal/apps/{appSlug}/actions/{actionSlug}/lookups/{argumentKey} Resolve choices for one action argument, such as finding Slack channels before sending a message. Run Universal Action POST /v2/universal/apps/{appSlug}/actions/{actionSlug}/run Run one published Universal API action through a connection.
Cirra The AI workspace: Analytics pages built from your apps’ data, and governance of what Cirra may do for each role.
Analytics › Pages › Pages Endpoint Request What it does List Analytics Pages GET /v2/analytics/pages See every Analytics page the key's creator can open, their own and the ones shared with them. Get Analytics Page GET /v2/analytics/pages/{pageId} Read a page: its settings, variables (filters), tabs, and its panels with their places on the grid. Create Analytics Page POST /v2/analytics/pages Make a new page or report. Update Analytics Page PUT /v2/analytics/pages/{pageId} Rename a page, change its icon, display, theme or style, pause or resume it, or file it in a folder. Convert Analytics Page POST /v2/analytics/pages/{pageId}/convert Make a page a subpage of the page whose click opens it, or a subpage an ordinary page again. Duplicate Analytics Page POST /v2/analytics/pages/{pageId}/duplicate Copy one of your pages, panels and settings included, as a new draft beside the original. Delete Analytics Page DELETE /v2/analytics/pages/{pageId} Delete one of your pages. Request Analytics Page Access POST /v2/analytics/pages/{pageId}/access-requests Ask the owner of a page you cannot open to share it.
Analytics › Pages › Building Endpoint Request What it does Get Analytics Page Definition GET /v2/analytics/pages/{pageId}/definition Read a page's whole draft as one document, in the shape Set Analytics Page Definition takes: change it and send it back. Set Analytics Page Definition PUT /v2/analytics/pages/{pageId}/definition Set a page's whole draft in one call: the fastest way to build a page, and the one to use from an agent. Validate Analytics Page Definition POST /v2/analytics/pages/{pageId}/definition/validate Check a body for Set Analytics Page Definition without saving anything. Set Analytics Page Variables PUT /v2/analytics/pages/{pageId}/variables Declare a page's variables: the filters its panels read as $name in their queries. Set Analytics Page Tabs PUT /v2/analytics/pages/{pageId}/tabs Split a page into tabs, rename or reorder them, or turn tabs off. Update Analytics Page Layout PUT /v2/analytics/pages/{pageId}/layout Arrange panels on the page grid (12 columns) and move them between tabs.
Analytics › Pages › Drafts and versions Endpoint Request What it does List Analytics Page Edits GET /v2/analytics/pages/{pageId}/edits See a page's draft steps since its last publish, newest first, with who made each and whether it is undone. Undo Analytics Page POST /v2/analytics/pages/{pageId}/undo Undo your last draft step on a page. Redo Analytics Page POST /v2/analytics/pages/{pageId}/redo Redo your last undone draft step on a page, or bring back a specific undone step by its id from List Analytics Page Edits. Publish Analytics Page POST /v2/analytics/pages/{pageId}/publish Publish the draft: it becomes a new numbered version and what viewers see. Discard Analytics Page Draft POST /v2/analytics/pages/{pageId}/discard-draft Throw away the draft and go back to the published version. List Analytics Page Versions GET /v2/analytics/pages/{pageId}/versions See a page's version history, newest first. Restore Analytics Page Version POST /v2/analytics/pages/{pageId}/versions/{versionId}/restore Bring an earlier version back as the draft. Publish Analytics Page Version POST /v2/analytics/pages/{pageId}/versions/{versionId}/publish Roll viewers back (or forward) to another version. Update Analytics Page Version PUT /v2/analytics/pages/{pageId}/versions/{versionId} Give a version a name or notes so its history reads well.
Analytics › Panels › Panels Endpoint Request What it does Create Analytics Panel POST /v2/analytics/pages/{pageId}/panels Add a blank panel to a page you own, or copy one with fromPanelId. Get Analytics Panel GET /v2/analytics/pages/{pageId}/panels/{panelId} Read a panel's whole setup in the shape Update Analytics Panel takes back: change what you need and send those fields. Update Analytics Panel PUT /v2/analytics/pages/{pageId}/panels/{panelId} Set what a panel shows: its sources and their SQL, the transform, the display type and its settings, columns, formats, click wiring and its place on the grid. Delete Analytics Panel DELETE /v2/analytics/pages/{pageId}/panels/{panelId} Delete a panel from a page you own. Create Analytics Subpage POST /v2/analytics/pages/{pageId}/panels/{panelId}/subpages Make a detail page that opens when a row or value of this panel is clicked.
Analytics › Panels › Output and previews Endpoint Request What it does Get Analytics Panel Output GET /v2/analytics/pages/{pageId}/panels/{panelId}/output See what a panel produces: its status, any failure message, and its rows, a window at a time. Preview Analytics Panel Transform POST /v2/analytics/pages/{pageId}/panels/{panelId}/transform-preview Try transform code on a panel's sources before you save it with Update Analytics Panel. Preview Analytics Panel Drill-Down POST /v2/analytics/pages/{pageId}/panels/{panelId}/drill-down-preview See what a drill-down panel shows for one click: pass the clicked row's values its SQL reads as $params.
Analytics › Data Sources › Sources Endpoint Request What it does List Analytics Data Sources GET /v2/analytics/data-sources See the data sources of the key's creator: the app data, merges and tables their Analytics panels read. Get Analytics Data Source GET /v2/analytics/data-sources/{dataSourceId} Get one of the creator's data sources in full: the app, action, connection, arguments, options and query a sync or live source fetches with; the inputs and code of a merge; the data a fixed source holds; its refresh schedule and incremental refreshes; and its latest fetch. Create Analytics Data Source POST /v2/analytics/data-sources Create a data source, owned by the key's creator, for Analytics panels to read. Update Analytics Data Source PUT /v2/analytics/data-sources/{dataSourceId} Change one of the creator's data sources. Delete Analytics Data Source DELETE /v2/analytics/data-sources/{dataSourceId} Delete one of the creator's data sources and its stored data. Fetch Analytics Data Source POST /v2/analytics/data-sources/{dataSourceId}/fetch Start a fresh fetch of a data source now, without changing it, as Refresh does in the app.
Analytics › Data Sources › Rows Endpoint Request What it does Get Analytics Data Source Result GET /v2/analytics/data-sources/{dataSourceId}/result Read a data source's stored rows and how its last fetch went. Query Analytics Data Source POST /v2/analytics/data-sources/{dataSourceId}/query Run one read-only SQL statement (DuckDB) over a data source's stored rows, read as src, to explore them before you build a panel: counts, distinct values, date ranges. Preview Analytics Merge POST /v2/analytics/data-sources/merge-preview Try a merge before you save it, as the app's merge editor previews one: send the same dataSources and transformCode Create Analytics Data Source takes for a merge source.
Analytics › Data Sources › Fixed tables Endpoint Request What it does Get Analytics Data Source Table GET /v2/analytics/data-sources/{dataSourceId}/table Read one of the creator's fixed sources as a table: its columns with their types, a window of its rows in order (each keyed by column; a row's index is offset plus its place), and the revision, also in the ETag header. Update Analytics Data Source Table PUT /v2/analytics/data-sources/{dataSourceId}/table Change some of a fixed source's table without sending the rest, then save it, as Save in the app's Edit table does: the panels and merges that read it follow.
Analytics › Sharing › Page shares Analytics › Sharing › Folder shares Endpoint Request What it does List Analytics Folder Shares GET /v2/analytics/folders/{folderId}/shares See who a folder is shared with. Create Analytics Folder Share POST /v2/analytics/folders/{folderId}/shares Share a folder with one target: every page in it, and in its subfolders, is shared with them too. Update Analytics Folder Share PUT /v2/analytics/folders/{folderId}/shares/{shareId} Change a share's permission between view and edit. Delete Analytics Folder Share DELETE /v2/analytics/folders/{folderId}/shares/{shareId} Take a share away from the folder and every page inside it.
Analytics › Publications Analytics › Library › Folders Endpoint Request What it does List Analytics Folders GET /v2/analytics/folders See the folders in your Analytics sidebar: your pages and reports, and the pages others shared with you, organized as you filed them. Create Analytics Folder POST /v2/analytics/folders Make a folder in your Analytics sidebar, at the top of Pages, Reports or Shared with me, or inside another folder. Update Analytics Folder PUT /v2/analytics/folders/{folderId} Rename, move, theme or pause one of your Analytics folders. Delete Analytics Folder DELETE /v2/analytics/folders/{folderId} Delete one of your Analytics folders.
Analytics › Library › Themes Endpoint Request What it does List Analytics Themes GET /v2/analytics/themes See your organization's Analytics themes: fonts, colors, chart and panel styling a page or a folder can wear. Create Analytics Theme POST /v2/analytics/themes Make a theme your organization can put on any page or folder. Update Analytics Theme PUT /v2/analytics/themes/{themeId} Change a theme.
Analytics › Library › Templates Endpoint Request What it does List Analytics Templates GET /v2/analytics/templates Browse ready-made Analytics pages and bundles you can install: your organization's, ones shared with it, and MindCloud's public library. Get Analytics Template Install Plan GET /v2/analytics/templates/{templateId}/install-plan See what a template needs before you install it: the apps to connect, the connections you can pick for each, and, for a bundle, its pages. Install Analytics Template POST /v2/analytics/templates/{templateId}/install Install a template as your own page, or a bundle as pages in a new folder.
Governance › Capabilities Endpoint Request What it does Get Capability Catalog GET /v2/capabilities See every Cirra capability key a role can allow or deny, its default, and how the keys fall back to each other. Get Member Capabilities GET /v2/members/{userId}/capabilities See what Cirra lets one member do (web search, files, shell, and each app) and whether their role, their own choices, or the default decided it. Get Role Capabilities GET /v2/roles/{roleId}/capabilities See what a role lets its members do in Cirra: web search, files, shell commands, and each app, model, or action. Update Role Capabilities PUT /v2/roles/{roleId}/capabilities Allow or deny what a role's members may do in Cirra, down to a single app action.
Governance › Connection access Endpoint Request What it does Get Connection Shares GET /v2/connections/{connectionId}/shares See who can use a shared connection when Cirra runs app actions, and what each of them may do with it. Update Connection Shares PUT /v2/connections/{connectionId}/shares Choose who can use a shared connection in Cirra and what they may do with it: everyone in the organization, roles, and teams, each at its own access level.
Governance › Spend limits Endpoint Request What it does Get Member Spend Limit GET /v2/members/{userId}/spend-limit See one member's Cirra credit limit. Update Member Spend Limit PUT /v2/members/{userId}/spend-limit Cap one member's Cirra credit use, or give them back the default.
Endpoint Request What it does List Platforms GET /v2/platforms See how people reach Cirra from Teams and Slack, and which roles they get. Get Platform GET /v2/platforms/{platformId} See the sign-in settings for Teams or Slack. Update Platform PUT /v2/platforms/{platformId} Set the email domains, guest access, automatic accounts, and group-to-role mappings for Teams or Slack sign-in.
Gravity Workflow automation: build, publish and run workflows, and follow their runs and usage.
Workflows Endpoint Request What it does List Workflows GET /v2/workflows See every workflow in your company. Get Workflow GET /v2/workflows/{workflowId} Fetch one workflow, including the full definition your team built and its summary. Create Workflow POST /v2/workflows Create an empty workflow. Update Workflow PUT /v2/workflows/{workflowId} Rename a workflow, enable or disable it with isActive, or replace its tags. Delete Workflow DELETE /v2/workflows/{workflowId} Delete a workflow. Duplicate Workflow POST /v2/workflows/{workflowId}/duplicate Copy a workflow, including its steps and schedules.
Building › Definition Endpoint Request What it does Get Workflow Definition GET /v2/workflows/{workflowId}/definition Read a workflow's whole structure in one call: its properties, its triggers, and its steps as a tree in execution order. Set Workflow Definition PUT /v2/workflows/{workflowId}/definition Set the workflow's whole draft in one call: the fastest way to build a workflow, and the one to use from an agent. Validate Workflow Definition POST /v2/workflows/{workflowId}/definition/validate Check a body for Set Workflow Definition without saving anything: it runs the same steps in a transaction that is always rolled back, so it finds every problem the write would, each with its JSON Pointer into the body.
Building › Steps › Steps Endpoint Request What it does List Workflow Steps GET /v2/workflows/{workflowId}/steps List a workflow's steps flat, in the order they run, with the number the editor shows and where each one sits. Get Workflow Step GET /v2/workflows/{workflowId}/steps/{stepId} Read one step: what it runs, the number the editor shows, and where it sits in the workflow. Add Workflow Step POST /v2/workflows/{workflowId}/steps Add a step to the workflow's draft. Update Workflow Step PUT /v2/workflows/{workflowId}/steps/{stepId} Change a step in the workflow's draft: its name, whether it runs, its action, or its app version. Delete Workflow Step DELETE /v2/workflows/{workflowId}/steps/{stepId} Remove a step from the workflow's draft. Duplicate Workflow Step POST /v2/workflows/{workflowId}/steps/{stepId}/duplicate Copy a step and every step inside it, with their connections: each must be one the key's creator may use. Set Workflow Step Order PUT /v2/workflows/{workflowId}/step-order Move any number of steps in one change: send the whole tree as you want it, the same shape Get Workflow Definition answers, with ids only.
Building › Steps › Configuration Endpoint Request What it does Get Workflow Step Schema GET /v2/workflows/{workflowId}/steps/{stepId}/schema Read what a step's configuration takes before you set it: its action's arguments as a tree with their types, choices and required ones; the options the action supports and their limits; the connection it needs; and the output fields later steps can reference. Get Workflow Step Configuration GET /v2/workflows/{workflowId}/steps/{stepId}/configuration Read how a step in the workflow's draft is set up: the arguments its action gets, nested as the action's schema nests them, with {{ steps.<stepId>.output... Update Workflow Step Configuration PUT /v2/workflows/{workflowId}/steps/{stepId}/configuration Change how a step in the workflow's draft is set up. Validate Workflow Step Configuration POST /v2/workflows/{workflowId}/steps/{stepId}/configuration/validate Send what you would send to Update Workflow Step Configuration and see what it would do: valid is false with every error in issues, or true with the configuration it would leave and the required values still missing. Run Workflow Step Lookup POST /v2/workflows/{workflowId}/steps/{stepId}/lookups List the choices of one dropdown of a step in the workflow's draft, or find the one you mean with q (or search), exactly as the editor loads them: the app's fixed options, a preset list, or a read from the app with the step's connection at its app version.
Building › Steps › Testing Endpoint Request What it does Test Workflow Step POST /v2/workflows/{workflowId}/steps/{stepId}/test Run one step of the workflow's draft on its own, exactly as Run in the editor does: with its saved configuration and connection, the saved sample outputs of the steps it references, and real side effects (a create step creates). Get Workflow Step Output GET /v2/workflows/{workflowId}/steps/{stepId}/output Read the sample output saved for a step in the workflow's draft, as the editor's Output tab shows it: its first records, how many there were, and the fields later steps can reference. Update Workflow Step Output PUT /v2/workflows/{workflowId}/steps/{stepId}/output Save a sample output for a step in the workflow's draft without running it, as Edit Step Output in the editor does.
Building › Triggers › Triggers Endpoint Request What it does List Workflow Triggers GET /v2/workflows/{workflowId}/triggers List what starts a workflow. Add Workflow Trigger POST /v2/workflows/{workflowId}/triggers Add a trigger to the workflow's draft. Update Workflow Trigger PUT /v2/workflows/{workflowId}/triggers/{triggerId} Rename a trigger in the workflow's draft, or turn it off or on. Delete Workflow Trigger DELETE /v2/workflows/{workflowId}/triggers/{triggerId} Remove a trigger from the workflow's draft.
Building › Triggers › Configuration Endpoint Request What it does Get Workflow Trigger Schema GET /v2/workflows/{workflowId}/triggers/{triggerId}/schema Read what a trigger's configuration takes before you set it: its action's arguments as a tree with their types, choices and required ones; the options the action supports and their limits; the connection it needs; and the output fields later steps can reference. Get Workflow Trigger Configuration GET /v2/workflows/{workflowId}/triggers/{triggerId}/configuration Read how a trigger in the workflow's draft is set up: the arguments its action gets, nested as the action's schema nests them, with {{ steps.<stepId>.output... Update Workflow Trigger Configuration PUT /v2/workflows/{workflowId}/triggers/{triggerId}/configuration Change how a trigger in the workflow's draft is set up. Validate Workflow Trigger Configuration POST /v2/workflows/{workflowId}/triggers/{triggerId}/configuration/validate Send what you would send to Update Workflow Trigger Configuration and see what it would do: valid is false with every error in issues, or true with the configuration it would leave and the required values still missing. Run Workflow Trigger Lookup POST /v2/workflows/{workflowId}/triggers/{triggerId}/lookups List the choices of one dropdown of a trigger in the workflow's draft, or find the one you mean with q (or search), exactly as the editor loads them: the app's fixed options, a preset list, or a read from the app with the trigger's connection at its app version.
Building › Triggers › Testing Endpoint Request What it does Listen Workflow Trigger POST /v2/workflows/{workflowId}/triggers/{triggerId}/listen Wait for a call to a Webhook trigger in the workflow's draft: send a request to the trigger's URL while this waits.
Endpoint Request What it does Get Workflow Inputs GET /v2/workflows/{workflowId}/inputs Read what a run of the workflow takes, where the editor keeps it. Update Workflow Inputs PUT /v2/workflows/{workflowId}/inputs Replace a whole list, as the editor stores it; a list not sent stays as it is.
Versions Endpoint Request What it does Validate Workflow POST /v2/workflows/{workflowId}/validate Check the workflow's draft the way publishing will: errors block publishing (an incomplete schedule, a broken graph), warnings do not (a step not set up yet, a Map step reading an input key no input answers). Publish Workflow POST /v2/workflows/{workflowId}/publish Make the draft the version that runs. List Workflow Versions GET /v2/workflows/{workflowId}/versions See a workflow's history: the current draft plus every published and unpublished version, newest first. Restore Workflow Version POST /v2/workflows/{workflowId}/versions/{version}/restore Copy a saved version into the draft, replacing it.
Runs › Run and cancel Endpoint Request What it does Run Workflow POST /v2/workflows/{workflowId}/run Start a run and get its id back right away. Cancel Run POST /v2/runs/{runId}/cancel Ask a run to stop.
Runs › History Endpoint Request What it does List Runs GET /v2/workflows/{workflowId}/runs See every time a workflow ran. Get Run GET /v2/runs/{runId} Check one run: status, timing, task count, and, while it is still running, the step it is on. List Run Steps GET /v2/runs/{runId}/steps See which steps a run executed and whether each one succeeded, without downloading any payloads. Get a Run Step GET /v2/runs/{runId}/steps/{stepInstanceId} Inspect one step of a run: the exact data it received and the exact data it returned. List Run Operations GET /v2/runs/{runId}/operations See every record a run created or updated, and every error or warning it hit. List Workflow Operations GET /v2/workflows/{workflowId}/operations Monitor record-level errors across every retained run of a workflow. List Operations GET /v2/operations Monitor record-level errors across workflows in one organization.
Usage Endpoint Request What it does Get Usage Summary GET /v2/usage Check how many tasks you have used this period and how close you are to your limit. Get Daily Usage GET /v2/usage/daily See how your task usage trends day by day, up to 45 days at a time. Get Usage by Workflow GET /v2/usage/workflows Find out which workflows use the most tasks, highest first, and how embedded usage splits across installations .
Embedded Connect your own end users’ apps from your product, and run actions with their accounts.
End Users Endpoint Request What it does List End Users GET /v2/embedded/end-users See the people using MindCloud Embedded inside your product. Get End User GET /v2/embedded/end-users/{endUserId} See one Embedded end user. Create End User POST /v2/embedded/end-users Add someone from your product so they can connect their own accounts through Embedded. Update End User PUT /v2/embedded/end-users/{endUserId} Update an end user's id, name, email, or metadata. Delete End User DELETE /v2/embedded/end-users/{endUserId} Remove an end user once their connections are gone.
Connections Endpoint Request What it does Create Embedded Connect Link POST /v2/embedded/end-users/{endUserId}/connect-links Create a single-use link for an end user to connect an app account. List Embedded End User Connections GET /v2/embedded/end-users/{endUserId}/connections List the public app accounts owned by one end user.
