# folk API Documentation

This is the complete API documentation for connecting to the folk API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **folk connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## folk actions

- POST `create-company` Create Company
- POST `create-deal` Create Deal
- POST `create-interaction` Create Interaction
- POST `create-note` Create Note
- POST `create-person` Create Person
- POST `create-reminder` Create Reminder
- POST `create-webhook` Create Webhook
- DELETE `delete-company` Delete Company
- DELETE `delete-deal` Delete Deal
- DELETE `delete-note` Delete Note
- DELETE `delete-person` Delete Person
- DELETE `delete-reminder` Delete Reminder
- DELETE `delete-webhook` Delete Webhook
- GET `get-company` Get Company
- GET `get-current-user` Get Current User
- GET `get-deal` Get Deal
- GET `get-note` Get Note
- GET `get-person` Get Person
- GET `get-reminder` Get Reminder
- GET `get-user` Get User
- GET `get-webhook` Get Webhook
- GET `list-companies` List Companies
- GET `list-deals` List Deals
- GET `list-group-custom-fields` List Group Custom Fields
- GET `list-groups` List Groups
- GET `list-notes` List Notes
- GET `list-people` List People
- GET `list-reminders` List Reminders
- GET `list-users` List Users
- GET `list-webhooks` List Webhooks
- PUT `update-company` Update Company
- PUT `update-deal` Update Deal
- PUT `update-note` Update Note
- PUT `update-person` Update Person
- PUT `update-reminder` Update Reminder
- PUT `update-webhook` Update Webhook