Sign inGet started
Docs
Get started

Getting Started

Read and change your MindCloud workflows, runs, connections, members, and settings over a versioned REST API.

Getting Started

The MindCloud API gives you programmatic access to the resources you manage in the platform: workflows, runs and their results, connections, members, roles, companies, environments, and task usage. You can read all of it, and change most of it: create and run workflows, cancel runs, invite and remove members, create custom roles and assign them, test and delete connections, update your company profile, and manage API keys.

Base URL

All requests go over HTTPS to:

https://connect.mindcloud.co

Choose an API version in the sidebar. v2 is selected by default, and each endpoint page shows its full versioned path.

Quick start

Create an API key in the platform, then verify it:

curl https://connect.mindcloud.co/v2/me \
  -H "Authorization: Bearer $MINDCLOUD_API_KEY"

List your workflows:

curl "https://connect.mindcloud.co/v2/workflows?limit=10&sort=-createdOn" \
  -H "Authorization: Bearer $MINDCLOUD_API_KEY"

Response envelope

Responses use the same envelope. Paginated list endpoints add pagination metadata:

{
  "success": true,
  "data": [{ "id": "Wq3kZ8pLx2Nb", "name": "Sync invoices" }],
  "meta": {
    "pagination": { "totalCount": 42, "totalCountExact": true, "hasNextPage": true, "hasPreviousPage": false }
  }
}

Errors carry a stable code, a readable message, and, when there is more to say, the specific reason:

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "Workflow \"Wq3kZ8pLx2Nb\" is disabled. Enable it with PUT /v2/workflows/:workflowId { \"isActive\": true } before running it.",
    "details": { "reason": "WORKFLOW_DISABLED" }
  }
}

Errors lists the codes.

OpenAPI

GET https://connect.mindcloud.co/v2/openapi.json serves an OpenAPI 3.1 document for every /v2 endpoint, with every parameter and response field typed. It needs no API key, so you can feed it straight to a client generator.

Next steps