Runn API Documentation

This is the complete API documentation for connecting to the Runn 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 Runn: Runn is resource and project planning software for managing people, projects, allocations, capacity, time off, and utilization. Keep reading to get started.

Quickstart

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

Every Runn action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/runn/latest/actions/{actionSlug}

You need a MindCloud API Key and a Runn connection. Then call an action such as Get Client:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/runn/latest/actions/get-client" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Runn account that should run the action. MindCloud stores and refreshes the Runn credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Runn actions

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

• GETGet Client
• GETGet Current User
• GETGet Holiday Group
• GETGet Person
• GETGet Person Current Team
• GETGet Project
• GETGet Project Total
• GETGet Rate Card
• GETGet Role
• GETGet Skill
• GETGet Team
• GETGet User
• GETList Assignments
• GETList Client Projects
• GETList Clients
• GETList Holiday Group Holidays
• GETList Holiday Groups
• GETList Milestones
• GETList People
• GETList Person Assignments
• GETList Person Holiday Time Off
• GETList Person Hour Report
• GETList Person Leave Time Off
• GETList Person Projects
• GETList Person Rostered Off Time Off
• GETList Person Skills
• GETList Project Assignments
• GETList Project Hour Report
• GETList Project Milestones
• GETList Project People
• GETList Project Phases
• GETList Project Rates
• GETList Project Totals
• GETList Project Workstreams
• GETList Projects
• GETList Rate Cards
• GETList Roles
• GETList Skill People
• GETList Skills
• GETList Team People
• GETList Teams
• GETList Users

Related apps

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

Google CalendarNotionTypeformJira Software CloudSmartsheetCal.comWufooBasecamp