folk API Documentation
This is the complete API documentation for connecting to the folk 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 folk: Manage contacts, companies, deals, notes, and reminders. Keep reading to get started.
Quickstart
Before you run your first folk request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one folk connection — create or choose one in Connections. Note its
connectionId.
Every folk action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/folk/latest/actions/{actionSlug}You need a MindCloud API Key and a folk connection. Then call an action such as Get Company:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/folk/latest/actions/get-company" \
--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 folk account that should run the action. MindCloud stores and refreshes the folk 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.
folk actions
All 36 published actions for this folk version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Company
- POSTCreate Deal
- POSTCreate Interaction
- POSTCreate Note
- POSTCreate Person
- POSTCreate Reminder
- POSTCreate Webhook
- DELETEDelete Company
- DELETEDelete Deal
- DELETEDelete Note
- DELETEDelete Person
- DELETEDelete Reminder
- DELETEDelete Webhook
- GETGet Company
- GETGet Current User
- GETGet Deal
- GETGet Note
- GETGet Person
- GETGet Reminder
- GETGet User
- GETGet Webhook
- GETList Companies
- GETList Deals
- GETList Group Custom Fields
- GETList Groups
- GETList Notes
- GETList People
- GETList Reminders
- GETList Users
- GETList Webhooks
- PUTUpdate Company
- PUTUpdate Deal
- PUTUpdate Note
- PUTUpdate Person
- PUTUpdate Reminder
- PUTUpdate Webhook
Related apps
More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.