vPlan API Documentation

This is the complete API documentation for connecting to the vPlan 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 vPlan: Plan work, manage boards, collections, cards, resources, orders, projects, and webhooks in vPlan. Keep reading to get started.

Quickstart

Before you run your first vPlan 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 vPlan connection — create or choose one in Connections. Note its connectionId.

Every vPlan action uses the same URL pattern:

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

You need a MindCloud API Key and a vPlan connection. Then call an action such as Retrieve Authentication Details:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/vPlan/actions/retrieve-authentication-details/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 vPlan account. See vPlan API Authentication for the full flow and how to get your connection credentials.

vPlan actions

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

• POSTCreate Activity
• POSTCreate Attachment Link
• POSTCreate Board
• POSTCreate Card
• POSTCreate Collection
• POSTCreate Comment
• POSTCreate Item
• POSTCreate Order
• POSTCreate Project
• POSTCreate Relation
• POSTCreate Stage
• POSTCreate Time Tracking Entry
• POSTCreate Warehouse
• POSTCreate Webhook
• GETGet Activity
• GETGet Attachment
• GETGet Board
• GETGet Card
• GETGet Collection
• GETGet Comment
• GETGet Group
• GETGet Item
• GETGet Order
• GETGet Project
• GETGet Relation
• GETGet Resource
• GETGet Stage
• GETGet Time Tracking Entry
• GETGet User
• GETGet Warehouse
• GETGet Webhook
• GETList Activities
• GETList Attachments
• GETList Boards
• GETList Cards
• GETList Collections
• GETList Comments
• GETList Groups
• GETList Items
• GETList Orders
• GETList Projects
• GETList Relations
• GETList Resources
• GETList Stages
• GETList Time Tracking Entries
• GETList Users
• GETList Warehouses
• GETList Webhooks
• GETRetrieve Authentication Details
• PUTUpdate Activity
• PUTUpdate Board
• PUTUpdate Card
• PUTUpdate Collection
• PUTUpdate Comment
• PUTUpdate Project
• PUTUpdate Stage

Related apps

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

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp