Vortex API Documentation

This is the complete API documentation for connecting to the Vortex API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Vortex: Manage invitations and autojoin domain configuration in Vortex. Keep reading to get started.

Quickstart

Before you run your first Vortex request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Vortex connection — create or choose one in Connections. Note its connectionId.

Every Vortex action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/vortex/actions/{actionSlug}/run

You need a MindCloud API Key and a Vortex connection. Then call an action such as Get Autojoin Domain By Id:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/vortex/actions/get-autojoin-domain-by-id/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Vortex account. See Vortex API Authentication for the full flow and how to get your connection credentials.

Vortex actions

All 16 published actions for this Vortex version. Each page documents the endpoint, arguments, and response controls.

• PUTAccept Invitation
• POSTConfigure Autojoin Domains
• POSTCreate Invitation
• DELETEDelete Autojoin Domain
• DELETEDelete Invitation
• DELETEDelete Invitations By Group
• DELETEDelete Invitations By Scope
• GETGet Autojoin Domain By Id
• GETGet Autojoin Domains By Scope
• GETGet Autojoin Invitations By Domain
• GETGet Invitation
• GETList Open Invitations By Group
• GETList Open Invitations By Scope
• GETList Open Invitations For Invitee
• PUTReinvite Invitation
• PUTSync Internal Invitation Decision

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp