---
title: Getting Started
description: 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 what you manage in MindCloud: your organization and its members, connections to other apps, Gravity workflows and their runs, and Cirra Analytics pages. You can read all of it, and change most of it.

## How the API is organized

The docs follow MindCloud's products. Pick one with **Category** in the sidebar; each shows its guides (how it works, and the recommended way to build with it) and, separately, its actions (one reference page per endpoint), both in nested folders.

- **MindCloud**: what every product runs on. Your organization, members, roles and API keys ([How Access Works](/docs/api/rest/introduction/access)), and connections to other apps and the Universal API ([How Connections Work](/docs/api/rest/introduction/connections)).
- **Cirra**: the AI workspace. Analytics pages built from your apps' data ([Analytics](/docs/api/rest/introduction/analytics)), and governance of what Cirra may do for each role.
- **Gravity**: workflow automation. Build, publish and run workflows, and follow their runs and usage ([How Workflows Work](/docs/api/rest/introduction/workflows)).
- **Embedded**: connect your own end users' apps from your product, and run actions with their accounts ([Connect end-user apps](/docs/api/rest/introduction/embedded-api)).

## Base URL

All requests go over HTTPS to:

```text
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. [All Endpoints](/docs/api/rest/introduction/all-endpoints) lists every endpoint on one page, and the [Workflow Building Guide](/docs/api/rest/introduction/workflow-building-guide) is the recommended way to build one, with what trips people up; [Build a Workflow](/docs/api/rest/introduction/build-a-workflow) covers each part in depth.

## Quick start

[Create an API key](https://app.mindcloud.co/user/api-keys) in the platform, then verify it:

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

List your workflows:

```bash
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:

```json
{
  "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:

```json
{
  "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](/docs/api/rest/introduction/requests#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

- [Authentication](/docs/api/rest/introduction/authentication) covers keys and company scoping.
- [Organizations](/docs/api/rest/introduction/organizations) covers acting in another organization with `X-Company-Id`, and finding it with List Companies.
- [Shape your requests](/docs/api/rest/introduction/requests) covers pagination, filtering, sorting, and field selection.
- [Workflow Building Guide](/docs/api/rest/introduction/workflow-building-guide) and [Analytics Building Guide](/docs/api/rest/introduction/analytics-building-guide) are the recommended paths to build a workflow and an Analytics page.
- [Connect end-user apps](/docs/api/rest/introduction/embedded-api) covers Embedded API catalog access, connection links, and scoped action runs.