Planfix API Documentation

This is the complete API documentation for connecting to the Planfix 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 Planfix: Manage Planfix tasks, projects, contacts, and employees. Keep reading to get started.

Quickstart

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

Every Planfix action uses the same URL pattern:

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

You need a MindCloud API Key and a Planfix connection. Then call an action such as List Tasks:

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

Planfix actions

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

• POSTAdd Task Comment
• POSTCreate Contact
• POSTCreate Project
• POSTCreate Task
• DELETEDelete Comment
• GETGet Comment
• GETGet Contact
• GETGet Employee
• GETGet Project
• GETGet Task
• GETList Contact Filters
• GETList Contact Templates
• GETList Contacts
• GETList Employees
• GETList Projects
• GETList Task Comments
• GETList Task Filters
• GETList Tasks
• PUTUpdate Contact
• PUTUpdate Project
• PUTUpdate Task

Related apps

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

Google CalendarNotionTypeformJira Software CloudCal.comWufooBasecampOnceHub