Week Plan API Documentation

This is the complete API documentation for connecting to the Week Plan 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 Week Plan: Access Week Plan workspaces, tasks, lists, roles, plans, recurrences, and user resources through the Week Plan v2 API. Keep reading to get started.

Quickstart

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

Every Week Plan action uses the same URL pattern:

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

You need a MindCloud API Key and a Week Plan connection. Then call an action such as Get Workspaces:

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

Week Plan actions

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

• PUTAdd User Email
• PUTBulk Update Actions
• PUTChange User Email
• PUTComplete Action
• POSTCreate Action
• POSTCreate List
• POSTCreate Promotion
• POSTCreate Role
• POSTCreate Session
• PUTDeactivate User
• PUTDeauthorize User Email
• DELETEDelete Action
• DELETEDelete List
• DELETEDelete Promotion
• DELETEDelete Recurrence Exception
• DELETEDelete Role
• DELETEDelete User
• PUTExtend User Trial
• POSTForgot Password
• GETGet Action
• GETGet Actions By Repetition and Date
• GETGet Actions in Date Range
• GETGet Board Lists
• GETGet Current User
• GETGet Day Actions
• GETGet High Impact Actions
• GETGet Inbox Actions
• GETGet Invoices
• GETGet Lists
• GETGet Lists Raw
• GETGet Meeting Actions
• GETGet Objective Lists
• GETGet Pro Licenses
• GETGet Role Lists
• GETGet Week Plan
• GETGet Workspaces
• POSTLogin Session MFA
• DELETELogout Session
• PUTPatch Action
• PUTPatch Event Action
• POSTRefresh Session Token
• PUTReorder Actions
• PUTReorder Goal Actions
• PUTReorder Objective Actions
• PUTReorder Role Actions
• PUTReorder Subtasks
• GETResend Verify Email
• GETSearch Actions
• POSTSign Up User
• PUTUpdate Action
• PUTUpdate Default Role
• PUTUpdate List
• PUTUpdate Password
• PUTUpdate Role
• PUTUpdate User
• PUTUpdate User Product

Related apps

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

Google CalendarNotionTypeformJira Software CloudCal.comWufooBasecampOnceHub